用途:为项目初始化一套完整文档结构。它会先探索代码库,再根据检测到的技术栈与配置,只生成与项目相关的文档,适合新项目起步、为已有项目补文档、整理文档结构或帮助新成员入门。
主要能力:核心文档始终生成,包括 docs/architecture.md(系统架构概览)、docs/onboarding.md(开发者入门指南)、docs/adr/0001-record-architecture-decisions.md(首个元 ADR)。检测到数据库时生成 docs/data-model.md;发现部署配置时生成 docs/deployment.md 与 docs/security.md;协作项目可生成 docs/contributing.md 与 docs/rfc/ 目录。模板位于 assets/templates/,会替换 {{PROJECT_NAME}}、{{DATE}}、{{TECH_STACK}}、{{DESCRIPTION}}、{{CONTEXT}} 等占位符。
使用方式:直接运行 docs-init 自动检测;也可附加上下文,如 docs-init for Python FastAPI microservice、docs-init for Next.js SaaS application、docs-init for React component library。它零配置、可重复运行,仅创建缺失文件,覆盖前会询问。
限制与注意:技能强调反臆造,记录前须读取真实文件确认存在、用 ls 或 find 精确计数、引用真实函数名、检查空目录,无法验证的内容不写入。资料未提供具体安装命令、收费方式与支持平台细节。