Documentation generation
Skill ligyDt/ai-ide-init-template/codex/.agents/skills/documentation-generation
面向 Codex、Cursor、CodeBuddy、TRAE 的中文 AI IDE 项目初始化模板，内置多角色协作、Skills、MCP、Hooks 与安全验证。
npx -y skills add ligyDt/ai-ide-init-template --skill documentation-generationAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 3 stars3 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its author says it does
Copied from the file, not written here
生成或更新 README、API 文档、架构说明、使用指南、变更说明、运行手册和交接文档。
SKILL.md
0.9 KB, as published. Nobody here has run it
文档自动生成
流程
- 明确文档读者、使用场景、维护位置和更新触发条件。
- 读取现有 README、接口定义、配置文件、脚本和架构决策，避免凭空编写。
- 区分用户指南、开发者指南、运维手册、API 文档和决策记录。
- 对外部账号、支付、生产数据、发布和部署内容只写安全边界与审批步骤，不写真实凭据。
- 输出结构清晰、可验证、可维护的中文文档。
输出
- 文档目标与读者
- 推荐目录结构
- 可直接落地的正文
- 验证命令与维护说明
停止条件
缺少目标、范围、运行环境或高风险授权时，先澄清或输出待确认事项，不擅自接入外部写入、支付、部署或生产资源。