Documentation Generation

生成或更新 README、API 文档、架构说明、使用指南、变更说明、运行手册和交接文档。 Use when this capability is needed.

tomevault-io Updated

File contents

文档自动生成

流程

  1. 明确文档读者、使用场景、维护位置和更新触发条件。
  2. 读取现有 README、接口定义、配置文件、脚本和架构决策,避免凭空编写。
  3. 区分用户指南、开发者指南、运维手册、API 文档和决策记录。
  4. 对外部账号、支付、生产数据、发布和部署内容只写安全边界与审批步骤,不写真实凭据。
  5. 输出结构清晰、可验证、可维护的中文文档。

输出

  • 文档目标与读者
  • 推荐目录结构
  • 可直接落地的正文
  • 验证命令与维护说明

停止条件

缺少目标、范围、运行环境或高风险授权时,先澄清或输出待确认事项,不擅自接入外部写入、支付、部署或生产资源。


Source: ligyDt/ai-ide-init-template — distributed by TomeVault.

tomevault-io/skills-registry/tree/main/ligydt--ai-ide-init-template--documentation-generation commit d5b08e6103

Frequently asked questions

npx skillmds@latest add tomevault-io/documentation-generation-6