工程开发
docs-write avatar

docs-write

项目文档结构与模板标准化,涵盖 README、API 文档、CLI 指南及目录结构规范。

简介

此技能提供了一套完整的框架,用于创建、组织和维护面向开发者的技术文档。它确保项目遵循一致的结构,使开发者能够更轻松地浏览、贡献并理解复杂的代码库。通过为项目目录布局(包括架构决策记录 ADR、API 规范、CLI 指令参考及开发工作流)建立明确标准,该技能为维护者和新贡献者创造了一个可预测的工作环境。

  • 标准化项目根目录文件(如 README.md、CONTRIBUTING.md 和 CHANGELOG.md),提供清晰的入门路径。

  • 实施分层文档架构,重点关注 TypeScript 类型定义、行内 JSDoc/TSDoc 注释以及结构化的 /docs 文件夹。

  • 定义 README 专用模板,确保功能介绍、安装步骤与快速启动指南易于扫描与操作。

  • 包含严格的 CLI 文档标准,如语法概述、参数说明、选项配置及错误处理示例。

  • 明确区分 README 内容(快速启动)与深入文档(架构、API、教学指南)。

  • 利用稳定的成熟度标签(Stable/Active/Early)来厘清不同组件、包或系统的状态。

  • 专为技术团队、开源维护者及重视可维护性的内部项目开发者设计。

  • 最适合用于初始化新存储库、重构过时文档,或在组织内实施一致的项目标准。

  • 建议搭配 internal:styleguide 技能以确保文风与语调一致,并配合 internal:voice 进行哲学导向的审查。

  • 预期输入包括项目结构目标、架构决策与 API 元数据。输出为结构严谨、专业且易于访问的文档,作为项目的单一事实来源。

仓库统计

Star 数
0
Fork 数
0
Open Issue 数
0
主要语言
TypeScript
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 19:25
在 GitHub 查看
docs-write | Skills Hub