用途:在 Markdown 中编写有效的技术文档,适用于 README、项目文档、API 参考与变更日志等场景。
主要能力:提供 README 结构(最小版与完整版模板,含徽章、功能、安装、用法、配置、API 参考、贡献与许可证);文档组织与文件命名约定(README.md、CONTRIBUTING.md、CHANGELOG.md、CODE_OF_CONDUCT.md、getting-started.md,以及 api/ 与 guides/ 目录);文档间链接写法;写作风格建议(简洁、主动语态、面向读者);代码文档(行内代码与代码块、命令与输出、完整配置示例);提示框(GitHub 风格 NOTE/TIP/IMPORTANT/WARNING/CAUTION 与 emoji 自定义提示);API 文档(端点请求/响应/错误示例、函数参数与返回值说明);Keep a Changelog 格式的变更日志;Mermaid 与 ASCII 图表。
使用方式:按资料中的模板与示例组织内容,例如安装命令使用 npm install,多命令放入代码块;配置示例给出完整有效 JSON;端点文档标注方法与状态码。
适用场景:开源项目、内部工具、库与 API 的文档撰写与维护。
限制:资料未提供该技能的安装方式、平台支持、收费与价格信息,暂未提供;内容为写作规范与示例,不涉及自动化生成或校验工具。