当前位置:主页中文技术文档的写作规范

6. 文档体系

文章来源:知付 更新时间:2022-05-28 17:11 热度:102

文档体系

结构

软件手册是一部完整的书,建议采用下面的结构。

  • 简介(Introduction):[必备] [文件] 提供对产品和文档本身的总体的、扼要的说明

  • 快速上手(Getting Started):[可选] [文件] 如何最快速地使用产品

  • 入门篇(Basics):[必备] [目录] 又称“使用篇”,提供初级的使用教程

  • 环境准备(Prerequisite):[必备] [文件] 软件使用需要满足的前置条件

  • 安装(Installation):[可选] [文件] 软件的安装方法

  • 设置(Configuration):[必备] [文件] 软件的设置

  • 进阶篇(Advanced):[可选] [目录] 又称“开发篇”,提供中高级的开发教程

  • API(Reference):[可选] [目录|文件] 软件 API 的逐一介绍

  • FAQ:[可选] [文件] 常见问题解答

  • 附录(Appendix):[可选] [目录] 不属于教程本身、但对阅读教程有帮助的内容

  • Glossary:[可选] [文件] 名词解释

  • Recipes:[可选] [文件] 最佳实践

  • Troubleshooting:[可选] [文件] 故障处理

  • ChangeLog:[可选] [文件] 版本说明

  • Feedback:[可选] [文件] 反馈方式

下面是两个真实范例,可参考。

文件名

文档的文件名不得含有空格。

文件名必须使用半角字符,不得使用全角字符。这也意味着,中文不能用于文件名。

错误:名词解释.md

正确:glossary.md

文件名建议只使用小写字母,不使用大写字母。

错误:TroubleShooting.md

正确:troubleshooting.md

为了醒目,某些说明文件的文件名,可以使用大写字母,比如 READMELICENSE

文件名包含多个单词时,单词之间建议使用半角的连词线( - )分隔。

不佳:advanced_usage.md

正确:advanced-usage.md
分享到:

#免责声明#

版权声明:《 6. 文档体系 》为作者 知付 原创文章,转载请注明原文地址!
本站所有文章,如无特殊说明或标注,均为本站原创或整合发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。
本文地址:https://www.yoppunion.com/%E4%B8%AD%E6%96%87%E6%8A%80%E6%9C%AF%E6%96%87%E6%A1%A3%E7%9A%84%E5%86%99%E4%BD%9C%E8%A7%84%E8%8C%83/133.html
同类推荐
评论列表
签到

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

支付宝扫一扫打赏

微信扫一扫打赏

微信扫一扫打赏