写作风格指南

写作风格指南

风格指南

风格指南 - 少数派创作手册 (sspai.com)

技术文档参考模板

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

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

• 快速上手（Getting Started）：[可选] [文件] 如何最快速地使用产品

• 入门篇

  （Basics）：[必备] [目录] 又称“使用篇”，提供初级的使用教程

  • 环境准备（Prerequisite）：[必备] [文件] 软件使用需要满足的前置条件
  • 安装（Installation）：[可选] [文件] 软件的安装方法
  • 设置（Configuration）：[必备] [文件] 软件的设置

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

• API（Reference）：[可选] [目录|文件] 软件 API 的逐一介绍

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

• 附录

  （Appendix）：[可选] [目录] 不属于教程本身、但对阅读教程有帮助的内容

  • Glossary：[可选] [文件] 名词解释
  • Recipes：[可选] [文件] 最佳实践
  • Troubleshooting：[可选] [文件] 故障处理
  • ChangeLog：[可选] [文件] 版本说明
  • Feedback：[可选] [文件] 反馈方式

列表参考模板

• 支持多种网盘：百度网盘, 阿里云盘, 天翼云盘, 迅雷云盘
• ✅ 支持多种操作系统：Windows，Linux，Mac
• ✅ 支持多种下载协议：HTTP，JSON-RPC，cURL
• ✅ 支持多种下载器：IDM，XDown，Aria2，NDM，Motrix，终端
• ✅ 支持批量获取网盘文件下载链接
• ✅ 可以通过 JSON-RPC 协议发送下载链接至本地或远程下载
• ✅ 支持更换皮肤，自动更新，新版网盘界面

三级标题顺序模板

三级标题

(1)xxxx

dawdawdawdaw

(2)xxxx

dawdwqadawdaw

更新时间：2025年3月20日22:40:55