用途:生成或更新项目内部技术文档。适用场景包括为目录、组件或项目根目录编写 README.md,为架构决策编写 ADR,以及编写 How-to 或概念性技术指南。
主要流程:先确定文档目标(具体文件、目录、组件或决策)和合适的产出类型,并确认放置位置(与代码同目录或 docs/ 文件夹)。然后阅读相关源代码以保证技术准确性,识别关键概念、架构模式和易踩的坑,并查看已有相关文档以避免重复、保持一致性。接着用 Technical Writer 角色起草内容,重点解释“为什么”和结构而非仅写“如何做”,使用主动语态和清晰简洁的英文,包含带语言标签的准确代码片段,复杂关系可用 Mermaid 图表示。最后做校验:命令是否可复制粘贴并正常运行、相对链接是否指向有效文件、语气是否与内部开发者文档一致。
限制:资料未提供具体安装方式、运行命令、依赖要求、输出格式或平台兼容性等信息,暂未提供。