Skip to content

Instantly share code, notes, and snippets.

@LeonDevLifeLog
Created June 28, 2018 06:44
Show Gist options
  • Save LeonDevLifeLog/fa83dc6af6bcccfdda7c733fcddcc532 to your computer and use it in GitHub Desktop.
Save LeonDevLifeLog/fa83dc6af6bcccfdda7c733fcddcc532 to your computer and use it in GitHub Desktop.
技术文档模板
  • 简介(Introduction): [必备] [文件] 提供对产品和文档本身的总体的、扼要的说明

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment