skills/bootstrap-docs/SKILL.md
Bootstrap or adapt project docs using project-documentation-template. Core goal - produce structured lifecycle documentation aligned with enterprise template. Initialize (empty) or Adjust (non-empty); repeatable; strict kebab-case naming.
npx skillsauth add nesnilnehc/ai-cortex bootstrap-docsInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
使用 project-documentation-template 结构引导或调整项目文档。两种模式:初始化(空项目——复制模板并填充占位符)和调整(非空——使用模板作为目标,建议重命名/移动/合并,确认后就地应用)。支持可重复运行;除非有要求,否则避免空目录和模板文件;强制执行严格的短横线命名。技能生成的产品(ADR、待办、设计决策、校准)的输出路径遵循 specs/artifact-contract.md; project-documentation-template 提供内容和参考。创建流程管理结构时,为每个合同创建 docs/process-management/project-board/待办/ 和 docs/process-management/decisions/。
治理目标:通过适合模式的引导或调整,生成与企业模板一致的结构化生命周期文档。
成功标准(必须满足所有要求):
[...] 占位符替换为项目特定内容(或明确标记以供以后使用)YYYYMMDD-slug-title.md 格式仓库测试:开发人员是否可以在不查阅模板存储库的情况下导航文档结构并查找生命周期文档?
本技能负责:
本技能不负责:
generate-agent-entry)转交点:建立文档结构并填充占位符后,将其移交给内容创作或特定于项目的文档工作流。
何时使用:当项目需要与企业模板一致的结构化生命周期文档时,或者当现有文档应与该结构一致时。
按 specs/artifact-contract.md §8 Runtime Norms Resolution Protocol 实现。适用于本技能产出的 ADR 与其他制品:
adr)的 path_pattern(默认:docs/process-management/decisions/YYYYMMDD-{slug}.md;项目可覆盖为聚合式)upstream_ref(ADR 通常指向关联的 design / requirement):在产出制品的 frontmatter emit parent: <upstream_ref>注:初始化模式下项目可能尚无 ARTIFACT_NORMS.md,Stage 0 fall-through 到技能默认,不阻断初始化工作。
首先确定执行模式。用户优先;否则:
|模式|触发|行为 |
| :--- | :------ | :----- |
| 初始化 |没有“docs/”或“docs/”为空 |复制子集,填充占位符,创建“VERSION”,输出文档骨架 |
| 调整 | docs/ 有 ≥1 个有效文档 |扫描、比较、输出推荐列表;用户确认后申请 |
检测规则:
docs/ 或 docs/ 为空 → 初始化docs/ 存在并且有 ≥1 个有效的 .md 文件 → 调整--mode=initialize 或 --mode=adjust → 使用该模式docs/design-decisions/(中+)、docs/calibration/、docs/process-management/project-board/待办/、docs/process-management/decisions/(大)。可以选择从合同创建“docs/ARTIFACT_NORMS.md”(根据 specs/artifact-norms-schema.md)供用户自定义。除非用户明确请求,否则不要创建其他空目录。[描述]、[选项1/选项2]、YYYY-MM-DD、[数字][README](../../README.md);外部[示例](https://example.com)YYYY-MM-DDdocs/process-management/decisions/YYYYMMDD-slug.md初始化 | 调整docs/、VERSION下填充文档,以及创建文件的简短摘要YYYY-MM-DD) 和 SemVer。不要做这些(其他技能可以处理它们):
generate-standard-readmegenerate-agent-entryrefine-skill-design何时停止并交接:
generate-agent-entryYYYYMMDD-slug-title.md 格式开发人员可以在不查阅模板存储库的情况下浏览文档结构并查找生命周期文档吗?
如果否:文档结构不完整或不清楚。返回特定于模式的步骤。
如果是:文档结构完整。继续转交。
上下文:新的存储库“my-service”,没有“docs/”目录。
步骤:Agent选择Initialize;规模=小。从模板复制项目概述、开发指南、用户指南。填写项目名称、日期、占位符描述。将“VERSION”创建为“1.0.0”。输出创建的文件的摘要。
输出片段:docs/project-overview/README.md、docs/development-guide/...、docs/user-guide/...、VERSION。所有占位符都填充了项目特定的内容。
上下文:回购协议有“docs/”和“project_overview/goals.md”(非标准路径)。一些占位符未填充。
步骤:代理选择“调整”。使用 project-documentation-template 作为目标。产生推荐列表:
project_overview/ → project-overview/,目录索引为 README.md(kebab-case 目录,README 为入口)docs/project-overview/README.md 中未填充的占位符:[项目描述]、[目标日期]../architecture/tech-stack.md(路径不存在)代理展示该列表并询问:“应用这些更改?(是/否)”。用户确认。代理重命名目录/文件,修复占位符和链接。没有创建新的空目录或模板文件。
上下文:任何项目;用户需要一个架构决策记录。
步骤:代理从模板中获取“docs/process-management/decisions/ADR-TEMPLATE.md”。确定下一个 ADR 编号(例如 ADR-001)。用用户输入填充上下文、选项、基本原理、结果。保存为“docs/process-management/decisions/YYYYMMDD-decision-title.md”(kebab-case slug)并更新决策索引(如果存在)。
|可交付成果 |必填|
| :--- | :--- |
|仅包含选定模板文件的“docs/”(无空目录)|是的 |
| 版本 文件 |是(除非用户明确请求不添加新文件)|
|所有占位符均已替换(或标记为稍后使用)|是的 |
|文档底部的版本历史表 |每个模板|
###调整模式推荐列表格式
|部分|内容 | | :--- | :--- | |目标参考| project-documentation-template | |路径/命名问题 |当前路径→推荐路径(kebab-case、模板对齐)| |可对齐文档 |可以重命名/移动/合并现有文档以匹配模板 | |未填充的占位符 |文件路径+占位符文本| |损坏/过时的链接 |文件路径+链接| |版本问题 |冲突或缺少版本参考 |
https://raw.githubusercontent.com/nesnilnehc/project-documentation-template/main/llms.txt、AGENTS.md、README.md、docs/development
Generate an LLM agent test suite (golden cases, mock-LLM unit tests, evaluator harness) from an agent implementation and its agent-test contract. Use when an agent has no tests, or a contract exists but the test code is missing.
development
After code changes, auto-detect the project's build system and local deployment method for a given directory, then build the project and restart its locally-deployed environment (Docker Compose / systemd / process manager). Never assumes — asks only when detection is ambiguous. Caches detected commands per project in .cortex/redeploy-local.yaml; re-invocations on the same project skip re-scanning until signal files change, the cache expires (30 days), or the skill version bumps.
tools
Publish a NATS message conforming to a cross-team contract, using NATS MCP tools. Authors the contract on first use if missing. Reads project-level cache (.cortex/nats.yaml) to avoid re-prompting basics across sessions.
tools
Drain pending NATS messages from a producer contract via NATS MCP tools (default batch / drain-style). Applies Tolerant Reader semantics and per-message ack/nak/term, returning aggregated stats. Reads project-level cache (.cortex/nats.yaml) to avoid re-prompting.