ADR 001: 使用 Markdown 就近维护项目文档【免费下载链接】claude-howtoA visual, example-driven guide to Claude Code — from basic concepts to advanced agents, with copy-paste templates that bring immediate value.项目地址: https://gitcode.com/GitHub_Trending/cl/claude-howtoStatusAcceptedContext项目同时维护 README、索引、多语言译文与多种代码文档。 过去文档分散在不同仓库与格式中检索困难且常与代码脱节 团队需要一种低门槛、易 diff、可被 CI 校验的文档组织方式。Decision所有文档统一使用 Markdown存放在各功能模块目录下就近维护 并通过文档生成脚本与校验脚本保证结构与链接的完整性。ConsequencesPositive文档与代码同库演进PR 中即可评审文档改动Markdown 可读性与 diff 友好性优于富文本格式可复用脚本自动化完成交叉引用与链接校验Negative需要为脚本与目录结构建立约定并维护大型二进制插图不适合纳入 Markdown 管理NeutralCI 流程需要新增文档校验步骤Alternatives ConsideredAlternative 1: 独立文档站点集中托管维护成本高文档与代码分属两个仓库易脱节未采用。Alternative 2: Word/PDF 等富文本无法 diff、不利于代码评审与自动化校验未采用。ReferencesRelated ADR: 无仓库文档校验脚本: scripts/check_cross_references.py【免费下载链接】claude-howtoA visual, example-driven guide to Claude Code — from basic concepts to advanced agents, with copy-paste templates that bring immediate value.项目地址: https://gitcode.com/GitHub_Trending/cl/claude-howto创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考