第 文档编写工具
Markdown语法详解、Typora与VS Code配置、文档版本管理（Git基础）
1. Markdown与桌面写作工具
Markdown适合快速记录、评审和版本管理；Typora适合所见即所得写作，VS Code适合和Git、检查插件、静态站点工具链结合。
| 工具 | 优势 | 适用场景 |
|---|---|---|
| Markdown | 轻量、可版本化、易转换 | 技术文档、README、接口说明 |
| Typora | 编辑体验顺滑，适合非开发人员 | 草稿撰写、评审前整理 |
| VS Code | 插件丰富，便于检查链接和格式 | 团队协作、文档站构建 |
| Git | 保留历史、支持分支和评审 | 版本管理、发布追溯 |
2. VS Code推荐配置
settings:
editor.wordWrap: on
markdown.preview.breaks: true
files.trimTrailingWhitespace: true
extensions:
- markdownlint
- markdown table formatter
- spell checker3. Git基础流程
- 为每次文档修改创建独立分支。
- 提交信息写清修改范围，例如 docs: update API auth guide。
- 通过Pull Request进行评审，确认术语、链接、截图和版本号。
- 合并后打标签，和产品版本或合规批次关联。
常见问题：多人直接编辑同一个Word文件容易覆盖变更；建议把规范正文迁移到Markdown或结构化文档仓库。