Create an OpenProject trial installation【免费下载链接】openprojectOpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub项目地址: https://gitcode.com/GitHub_Trending/op/openprojectStart a new trial installation**界面文本UI text**提到具体 UI 文本如按钮标签或菜单项时使用应用中的名称并将首字母大写同时**加粗**。例如**Start free trial** 按钮。 **功能名称Feature names**功能名称通常首词大写并加粗例如 **Gantt chart**、**Roadmap**、**Project overview**、**News**、**Wiki**。 **其他术语**以下名称需大写 - OpenProject 产品名OpenProject Community edition、OpenProject Enterprise on-premises edition、OpenProject Enterprise cloud edition - 第三方组织、软件与产品例如 Nextcloud、The Linux Foundation - 遵循第三方自身的大小写风格可能非标准例如 OpenProject、GitHub。 ### 占位符Placeholders - **用户信息**不要在文档中使用真实用户信息或邮箱地址。邮箱统一使用以 example.com 结尾的地址姓名使用 example_username 这类字符串或使用多样、无性别倾向且姓氏常见的名字如 Avery Smith截图时不要暴露真实头像应创建虚拟用户名与头像。 - **URL**示例 URL 使用 example.com。 - **令牌Tokens**演示 API 调用需要令牌时即使被滥用的概率很低也强烈建议不使用真实令牌。官方示例令牌12345678910ABCDE。 - **命令**需要读者替换文本时用 自定义 标注。例如 shell cp your_source_directory your_destination_directory缩写Contractions不要使用任何缩写形式如 dont、isnt。标点Punctuation避免使用分号改用两个句子句中使用破折号替代逗号时前后必须加空格不要使用双空格冒号在句中时冒号后用小写字母。词间空格只使用标准空格确保搜索引擎能检索到各个检索词。列表Lists列表项总是以大写字母开头仅当列表项描述操作步骤序列时使用有序列表否则使用无序列表无序列表使用连字符-标记列表项末尾不加逗号,或分号;列表项与解释文字之间用冒号:分隔例如Feature 1: very attractive new featureFeature 2: description of an additional feature表格Tables表格用于描述复杂信息。很多情况下每个条目只有一个简单描述时无序列表就足够了但如果数据适合用矩阵描述表格是最佳选择。创建规范为保证表格可访问、可扫读表格不应有空单元格若确实没有内容填入 N/Anot applicable或 none。为便于维护可在列宽上添加额外空格以保持对齐一致。例如推荐| **Feature** | **Description** | | ------------- | --------------------------------------------------------- | | Great feature | Enhances collaboration between marketing and sales | | Best feature | Use it to synchronize your example table with OpenProject |而不是列宽参差不齐的写法。标题Headings每个文档页只使用一个 H1#开头从 H2##开始遵守 H2 H3 的层级顺序绝不跳级如 H3 后接 H2层级不要低于 H3###标题中不使用符号和特殊字符尽量不包含将来可能变化的词汇——修改标题会改变其锚点 URL影响其他页面的链接标题前后各留恰好一个空行标题中不使用链接副标题要清晰、描述完整便于用户找到正确的示例标题保持清晰直接每个词都有价值尽量使用祈使句例如Sign in with an existing account不要写成 Signing in with an existing account锚点链接标题渲染时自动生成锚点## This is an example会生成锚点#this-is-an-example。互联网上有大量指向 OpenProject 文档页与锚点的链接因此请避免修改既有标题。链接Links链接在文档中非常重要用链接代替重复内容以维护单一事实来源。基本规范使用行内链接 Markdown 语法[Description](https://example.com)更易阅读、审查与维护使用有意义的锚文本描述例如写Read more about Gantt charts而不是Read more about Gantt charts here。内部文档链接OpenProject 网站内部含文档的链接使用相对链接即不用完整 URL而是表示当前 URL 与目标 URL 的关系链接到同一仓库中的 Markdown 文件使用相对路径用../导航到更高级目录。外部文档链接链接外部信息时使用绝对 URL且只链接权威来源——由产品或内容的创建者撰写的官方、可信来源这样最可能准确且持续更新。导航术语Navigation菜单Menus提及 OpenProject 主要应用元素时使用以下术语Header menu顶部横跨应用宽度的蓝色条包含 OpenProject 标志、搜索框、所有项目链接、全局模块、帮助图标和用户头像Project menu应用左侧的菜单选择项目后显示各模块。项目菜单项都按应用内的拼写加粗书写例如In the project menu, selectWork packagesto open your work package table.导航路径写法为保持一致写 UI 导航路径时使用应用中的名称、斜体、箭头连接。例如In the header menu, click on yourAvatar Administrationto find system settings.图片Images图片含截图能帮助读者更好地理解指南但随软件更新维护成本高应克制使用。纳入图片前先确认它是否对读者有价值。截图规范只截取最相关的区域不要包含无意义的空白或无法说明问题的页面区域。OpenProject 应用左侧的项目菜单可能会变化除非必要不要包含它保持一致与页面中其他截图风格协调例如其他截图包含左侧边栏则所有截图都包含。高亮区域与编号标签可高亮截图中的特定区域吸引读者注意并添加编号标签用于在正文中引用。高亮与标签使用要克制因为界面任何变更都需要手动更新每个截图的高亮和标签。高亮区域用绿色矩形3px 宽设计系统Accent/Accent色 #308720编号标签为浅灰文字Basic/Grey 6#F3F3F3置于 24 像素绿色圆Accent/Accent#308720上配 2px 浅灰描边正文中引用编号标签时用从 1 开始的有序列表对应截图中标注的部分也可在行文中用 (Area 1) 的形式引用。保存图片优先使用 PNG 格式仅当图片是照片或 PNG 超过 200 KB 时使用 JPG尽量用 squoosh 等工具以 OxiPNG 或 MozJPEG 压缩文件名描述图片内容使用小写且无空格见目录与文件命名规范图片大小不超过 200 KB图片放在你正在编辑的 README.md 所在目录GIF 压缩后最大2 MB。添加图片链接Markdown 引入图片的语法为Image description which will be the alt tag。图片描述即渲染后的 alt 文本为兼顾可访问性与 SEO描述应简短准确。视频Videos目前外部贡献者无法向文档上传视频如需添加视频请提交 ticket。提示框Alert boxes提示框用于唤起对信息的注意OpenProject 文档有特定格式需保持一致 **Note**: If you do not have an OpenProject installation yet, please visit our site on how to create an OpenProject trial installation.警示AlertsAlerts 是 GitHub 基于 blockquote 语法的 Markdown 扩展用于强调关键信息 [!NOTE] Useful information that users should know, even when skimming content. [!TIP] Helpful advice for doing things better or more easily. [!IMPORTANT] Key information users need to know to achieve their goal. [!WARNING] Urgent info that needs immediate user attention to avoid problems. [!CAUTION] Advises about risks or negative outcomes of certain actions.【免费下载链接】openprojectOpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub项目地址: https://gitcode.com/GitHub_Trending/op/openproject创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考