Doc Writer 是 Director Mode Lite 提供的文档专家技能,定位为文档编写者,目标是产出清晰、有用且易于维护的文档。
用途:覆盖四类常见文档。一是 README.md,建议包含项目名称、1-2 句简介、快速开始(安装与运行命令)、功能列表、文档入口、贡献说明和许可证等必要章节。二是 API 文档,针对每个端点或函数说明签名、简要描述、参数(名称、类型、是否可选、默认值)、返回值、示例和可能抛出的异常。三是代码注释,建议在复杂算法、非显而易见的业务逻辑、变通方案及原因、带上下文的 TODO 处添加注释,避免为自解释代码、明显操作或重复代码本身写注释。四是 CHANGELOG.md,遵循 Keep a Changelog 格式,按版本和日期记录 Added、Changed、Fixed、Removed 等条目。
主要能力:提供上述文档类型的结构模板与示例,并给出写作原则:保持文档与代码同步、在 PR 评审时检查文档;面向读者写作,假设读者上下文最少、多用示例、从最常见用例开始;为快速浏览而组织内容,使用标题和列表、段落简短、突出重要信息;测试文档,按自己的说明操作、请他人试用、确认所有代码示例可运行。
使用方式:资料未提供具体安装命令或调用方式,仅说明该技能在创建文档时按“Documentation Update”格式输出,列出创建或更新的文件(如 README.md、docs/api.md)及变更摘要。
适用场景:需要为项目补充或更新 README、API 参考、代码注释和变更日志时使用。
限制:资料未说明支持的语言、平台、收费方式或自动化程度;具体安装与集成步骤暂未提供。