document

分类: 工具与效率 | 上传者: bitcraft-apps | 下载: 0 | 版本: v1.0（最新）

Generate minimal documentation through parallel agents

更新日志: Source: GitHub https://github.com/bitcraft-apps/claude-spec-first

目录结构

当前层级: skills/document/

📄 SKILL.md 2.8 KB

SKILL.md

---
name: document
description: Generate minimal documentation through parallel agents
disable-model-invocation: true
argument-hint: "[SPECIFICATION_AND_IMPLEMENTATION_PATHS]"
---

# Document Command

Creates minimal, proportional documentation. Match doc weight to change weight.

## Usage
```
/csf:document [SPECIFICATION_AND_IMPLEMENTATION_PATHS]
```

---

## Project Context
- Implementation summary: !`test -f .claude/.csf/implementation-summary.md && head -20 .claude/.csf/implementation-summary.md || echo "none"`

## Input Resolution

**Input Resolution:**

1. If $ARGUMENTS provided: Use as artifact/implementation paths
2. Else if `.claude/.csf/spec.md` and `.claude/.csf/implementation-summary.md` exist: Use them
3. Else: Use **AskUserQuestion** tool to ask for artifact locations

## Execution

After input resolution, run agents in 3 batches:

**Batch 1 (Parallel):**
- Task: analyze-artifacts (maxTurns: 6) with requirements: $ARTIFACT_PATHS
- Task: analyze-implementation (maxTurns: 10) with requirements: $IMPLEMENTATION_PATHS
- Task: analyze-existing-docs (maxTurns: 6) (scans project for existing documentation inventory)

**Gate 1 — Post-Analysis:**
Check that each output file exists and is non-empty:
- `$CSF_DIR/research/artifacts-summary.md`
- `$CSF_DIR/research/implementation-summary.md`
- `$CSF_DIR/research/docs-inventory.md`

If any file is missing or empty: halt pipeline, report which file(s) failed, preserve existing output for inspection. Write gate results to `$CSF_DIR/research/gate-analysis.md` (pass/fail per file, warnings for files under 5 lines).

**Batch 2 (Parallel):**
- Task: create-technical-docs (maxTurns: 15) (reads $CSF_DIR/research/artifacts-summary.md, $CSF_DIR/research/implementation-summary.md)
- Task: create-user-docs (maxTurns: 15) (reads $CSF_DIR/research/artifacts-summary.md, $CSF_DIR/research/implementation-summary.md)

**Gate 2 — Post-Generation:**
For each generated doc, verify:
1. File exists (empty is acceptable — means the change didn't warrant that doc type)
2. No placeholder patterns: `TODO`, `TBD`, `PLACEHOLDER`, `[INSERT` (case-insensitive)

Block on: placeholder-only content. Empty files are valid — they mean the agent correctly determined no docs were needed. Write gate results to `$CSF_DIR/research/gate-generation.md`.

**Batch 3:**
- Task: integrate-docs (maxTurns: 15) (reads docs-inventory.md to update existing files or create new ones)

**Gate 3 — Post-Integration:**
Verify integration completed. If no docs were updated or created, that's valid — report "no documentation changes needed" and finish cleanly. Write gate results to `$CSF_DIR/research/gate-integration.md`.

Output: Documentation updates (if any) + terminal summary

## Gate Failure Behavior
On any gate failure: halt immediately, do not proceed to the next batch. Report which gate failed and why. Preserve output for inspection.

登录后下载/点赞/收藏 ❤ 4 | ★ 0

document

目录结构

SKILL.md

举报内容

提示