Create Professional Markdown Documentation

解决什么问题

开源项目或内部工具的文档经常面临这样的困境：README 结构混乱、安装步骤缺失、API 说明不完整，导致贡献者需要反复提问才能上手。这个 Skill 为 Claude、Codex 和 Claude Code 提供了一套结构化模板和本地工具，覆盖 README、Changelog、贡献指南等常见文档类型的规范化写作流程，让文档从「随意发挥」变成「有章可循」。

核心能力

1. 结构化 README 模板：生成包含项目简介、安装步骤、基本用法、API 说明、贡献指南和许可证的完整 README 草稿。
2. 标准化 Changelog：按 Keep a Changelog 规范组织内容，使用 conventional commit 分类组织变更条目，突出 Breaking Changes。
3. 目录自动生成：通过内置 Python 辅助工具从标题层级自动生成 Markdown 目录，无需手动维护。
4. Git 历史转 Changelog：读取本地 Git 提交历史，将 commits 自动整理成分类好的变更日志，可直接写入指定文件。
5. 本地链接校验：检查 Markdown 文件中的内部链接，报告失效的链接目标，不依赖外部网络请求。
6. 多场景模板库：提供 README、Changelog、贡献指南的参考模板，覆盖开源项目文档的主要场景。

适用场景

• 新项目初始化：项目立项时用模板快速生成完整的 README 框架，后续逐步填充内容，而不是到需要发布时才发现文档残缺。
• 版本发布准备：将 Git 提交历史转化为规范的 Changelog，确保发布说明准确反映本次变更，避免手动整理遗漏。
• 文档一致性审查：定期用 Skill 审计现有文档集，检查标题层级、链接有效性和内容重复问题，提升整体可读性。
• 跨仓库文档标准化：团队多个项目使用同一套文档模板，保证贡献者在不同项目间切换时有一致的体验。

使用方式

安装后，通过 Prompt 模板触发具体任务。例如输入「为 [项目] 创建一份 README」，Skill 会引导 Claude 按照标准结构生成各章节，并在生成后提醒需要填入的具体信息。可结合 Git 历史功能自动生成 Changelog，保持发布说明与实际变更同步。

为什么值得用

• README、Changelog、贡献指南全部有现成模板，不用每次从零排版。

• Git 历史自动转 Changelog，发布时无需手动整理 commit 列表。

• 本地链接校验在提交前发现问题，避免文档读者点击 404。

• Python 辅助工具轻量且本地运行，不依赖外部服务。

安装方式

npx skillstore add autumnsgrove/markdown-pro

支持工具：Claude、Codex、Claude Code | 风险等级：safe | 安全审计：通过