文档编写
文档页交互规范与内容编写建议。
页面交互
文档页默认提供:
Copy MarkdownOpen- 右侧目录高亮跟随
编写建议
- 先给结论,再展开细节。
- 优先写业务行为,不写仓库内部结构。
- 配置项用步骤化表达,减少纯概念描述。
- 每页给一个“下一步”入口,帮助继续阅读。
Mermaid 使用
支持 Mermaid 流程图,可用于表达业务链路。
Rendering diagram...
文档页交互规范与内容编写建议。
文档页默认提供:
Copy MarkdownOpen支持 Mermaid 流程图,可用于表达业务链路。