该技能提供自包含的技术文档写作专长,适用于任意用户项目,聚焦面向开发者的文档:README、API 参考、教程与变更日志。
用途与主要能力:一是 README 撰写,建议结构为项目名、一句话描述、功能、安装、快速开始、用法、API 参考、贡献与许可证,强调先讲价值、多用代码示例、渐进式披露并随代码更新。二是 API 文档,涵盖函数/方法注释(@param、@returns、@example 等)与 REST 接口说明(请求、响应、错误码),并提供 OpenAPI 3.0 模板。三是教程,要求前置条件、可测试的小步骤、每步预期输出与后续延伸。四是变更日志,采用 Keep a Changelog 格式与语义化版本,分类为 Added、Changed、Deprecated、Removed、Fixed、Security。
风格指南:优先主动语态、现在时,教程用第二人称;表述具体,避免或解释术语,句子简短。代码示例应完整可运行并包含错误处理。信息架构按用户旅程组织(getting-started、guides、api-reference、examples),保持标题层级一致、交叉链接与目录。文档维护涉及版本化目录、迁移指南、自动化生成与评审清单。
限制:资料未提供该技能的安装方式、收费、平台支持或具体使用步骤,暂未提供相关信息。