SuperAPI AI 工具集

full-stack-doc

写作与研究

查看项目

更新于 10-15 21:48

技能介绍

用途:full-stack-doc 是一套产品文档标准(v3.0),用于创建或初始化产品文档仓库、为产品族或单产品搭建文档树、审计或对齐已有仓库、按命名规范生成或重命名文档,以及编写 10 份根级规划文档。

主要能力:提供可直接复制的 Markdown 模板,分为根级(10 份,产品级、与版本无关)、版本级(7 份)、模块级(每模块 3 份,可选)、交付级(5 份,可选),另有 README、架构等模板族。模板使用双花括号占位符,如 {{PRODUCT_NAME}}、{{VERSION}}、{{MODULE_NAME}}、{{DATE}}、{{OWNER}}、{{ORGANIZATION}}、{{DOC_ROOT}},需在文件名与内容中替换。

使用方式:先按需加载 references/ 下的说明(占位符协议、文档边界、适用性、示例档案、质量评分、结构映射、README 与架构模板指南),再复制模板并重命名。示例命令:for f in templates/root/*.md; do name=$(basename "$f" | sed 's/{{PRODUCT_NAME}}/ExampleCommerce/g'); cp "$f" "product-docs/ExampleCommerce/$name"; done。校验命令:python3 scripts/validate_templates.py;架构文件名校验:python3 scripts/validate_architecture_filenames.py docs/ExamplePlatform-Architecture.md docs/ExamplePlatform-Architecture.zh_CN.md。

适用场景:产品文档仓库初始化、文档树搭建、现有仓库对齐、命名规范生成、根级规划文档编写与扩展。

限制:版本目录序号 1–7 保留给 7 份标准文档,非标准文档须用 8+ 或放入 其他/;根目录仅保留一个编号 6 的文件;不要擅自重组 demo/、assets/、.stitch/ 等特殊目录;交付模板可选且不占用根级序号;双轨产品需各自完整 10 份文档。行数、表格数、图表数只是诊断指标,不是验收门槛;不确定内容须标注为推断、假设或待确认。具体收费、价格、平台与效果暂未提供。