Wow4j Wow4j
首页
个人使用说明书
后端开发
前端开发
测试开发
运维开发
大数据开发
产品&UI交互
团队管理
软技能
他山之石
开源产品
敬请期待
GitHub (opens new window)
首页
个人使用说明书
后端开发
前端开发
测试开发
运维开发
大数据开发
产品&UI交互
团队管理
软技能
他山之石
开源产品
敬请期待
GitHub (opens new window)
  • 概要
  • 如何一键生成项目树形结构
  • Markdown书写利器Typora最佳实践指南
  • 浅谈如何提升职场晋升力
  • 复盘的技巧:深度复盘的三个步骤【转载】
  • 好文档最佳实践

    • 中文技术文档写作规范(Markdown版)
    • 如何写出一份合格的技术文档
    • 字节跳动优秀文档 8 大秘籍
    • 写好文档检查清单
    • 软件手册范例
  • 软技能
  • 好文档最佳实践
timchen525
2023-01-31

软件手册范例

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

  • 简介(Introduction):[必备] [文件] 提供对产品和文档本身的总体的、扼要的说明
  • 快速上手(Getting Started):[可选] [文件] 如何最快速地使用产品
  • 入门篇(Basics):[必备] [目录] 又称“使用篇”,提供初级的使用教程
    • 环境准备(Prerequisite):[必备] [文件] 软件使用需要满足的前置条件
    • 安装(Installation):[可选] [文件] 软件的安装方法
    • 设置(Configuration):[必备] [文件] 软件的设置
  • 进阶篇(Advanced):[可选] [目录] 又称“开发篇”,提供中高级的开发教程
  • API(Reference):[可选] [目录|文件] 软件 API 的逐一介绍
  • FAQ:[可选] [文件] 常见问题解答
  • 附录(Appendix):[可选] [目录] 不属于教程本身、但对阅读教程有帮助的内容
    • Glossary:[可选] [文件] 名词解释
    • Recipes:[可选] [文件] 最佳实践
    • Troubleshooting:[可选] [文件] 故障处理
    • ChangeLog:[可选] [文件] 版本说明
    • Feedback:[可选] [文件] 反馈方式
上次更新: 2023/01/31, 17:37:12
写好文档检查清单

← 写好文档检查清单

Theme by Vdoing | Copyright © 2022-2023 timchen525 | MIT License
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式
×