templates:由The Good Docs Project创建的模板-满足您所有的技术写作需求

关于模板仓库 该存储库包含最佳实践模板，以帮助构建开源软件的文档，顺便说一句，该文档也直接适用于其他域。 在这里，我们提供了使用这些模板的提示。 核心文件类型 模板分为三种文档类型： 概念：描述某事如何以及为什么起作用。 概念回答“这是什么？”的问题。 当读者阅读概念时，他们正在学习一个主题。 在开始使用技术之前，请使用概念帮助读者理解技术。 任务：提供有关如何完成工作的具体说明。 任务回答问题“我该怎么办？”。 读者阅读任务时，他们正在做某事。 任务往往有一个特定的目标，并且由一组编号的步骤组成，读者可以按照这些步骤来实现该目标。 参考：包含用户使产品工作所需的结构化信息或规格。 参考资料回答了“我还需要知道什么？”这个问题。 读者阅读参考文献时，他们正在检查事实。 参考部分应全面分类数据，例如功能及其参数，返回代码和错误消息。 它们通常以表格，项目符号列表或示例脚本的形式呈现。