with one click
scan-feature-docs
// [Documentation] Use when scanning feature documentation structure, app-to-service mapping, templates, and conventions.
// [Documentation] Use when scanning feature documentation structure, app-to-service mapping, templates, and conventions.
[HINT] Download the complete skill directory including SKILL.md and all related files
| name | scan-feature-docs |
| description | [Documentation] Use when scanning feature documentation structure, app-to-service mapping, templates, and conventions. |
Codex compatibility note:
- Invoke repository skills with
$skill-namein Codex; this mirrored copy rewrites legacy Claude/skill-namereferences.- Prefer the
plan-hardskill for planning guidance in this Codex mirror.- Task tracker mandate: BEFORE executing any workflow or skill step, create/update task tracking for all steps and keep it synchronized as progress changes.
- User-question prompts mean to ask the user directly in Codex.
- Ignore Claude-specific mode-switch instructions when they appear.
- Strict execution contract: when a user explicitly invokes a skill, execute that skill protocol as written.
- Subagent authorization: when a skill is user-invoked or AI-detected and its protocol requires subagents, that skill activation authorizes use of the required
spawn_agentsubagent(s) for that task.- Do not skip, reorder, or merge protocol steps unless the user explicitly approves the deviation first.
- For workflow skills, execute each listed child-skill step explicitly and report step-by-step evidence.
- If a required step/tool cannot run in this environment, stop and ask the user before adapting.
Codex does not receive Claude hook-based doc injection. When coding, planning, debugging, testing, or reviewing, open project docs explicitly using this routing.
Always read:
docs/project-config.json (project-specific paths, commands, modules, and workflow/test settings)docs/project-reference/docs-index-reference.md (routes to the full docs/project-reference/* catalog)docs/project-reference/lessons.md (always-on guardrails and anti-patterns)Situation-based docs:
backend-patterns-reference.md, domain-entities-reference.md, project-structure-reference.mdfrontend-patterns-reference.md, scss-styling-guide.md, design-system/README.mdfeature-docs-reference.mdintegration-test-reference.mde2e-test-reference.mdcode-review-rules.md plus domain docs above based on changed filesDo not read all docs blindly. Start from docs-index-reference.md, then open only relevant files for the task.
Goal: Scan existing business feature documentation → populate docs/project-reference/feature-docs-reference.md with app-to-service mapping, documentation structure conventions, template usage, and section standards.
Workflow:
Key Rules:
[BLOCKING] Determine mode before any other step:
test -f docs/project-reference/feature-docs-reference.md && echo "SYNC mode" || echo "INIT mode"
| Mode | Condition | Behavior |
|---|---|---|
| INIT | feature-docs-reference.md does not exist | Create from scratch; scan entire docs/business-features/ |
| SYNC | feature-docs-reference.md exists | Read existing file first; update changed sections only |
| FORCE | User explicitly says "rebuild" or "reset" | Treat as INIT even if file exists |
Detect documentation structure type:
| Signal | Type | Scan Approach |
|---|---|---|
docs/business-features/{App}/ directories | App-bucketed feature docs | Scan per-app, map to services |
docs/features/{Feature}.md flat structure | Feature-per-file | Scan each file, derive categories |
wiki/ or external doc system links | Wiki-based | Scan wiki references, note external |
| README.md embedded in service dirs | Source-embedded | Scan src/**/*.md files |
Path: INIT → Phase 1 → Phase 2 (full scan) → Phase 3 (full write) → Phase 4 (verify) Path: SYNC → Phase 0 read existing → Phase 1 → Phase 2 (diff scan, new/changed only) → Phase 3 (targeted update) → Phase 4 (verify)
Create task tracking entries for each sub-agent and each verification step.
Discover documentation locations:
docs/ directory structure (business features, architecture, guides)docs/business-features/ or similar feature doc directoriesdocs/templates/ or similar template directoriesUse docs/project-config.json if available for module lists and app mappings.
Launch 2 general-purpose sub-agents in parallel. Each MUST:
file:line for every findingAll findings → plans/reports/scan-feature-docs-{YYMMDD}-{HHMM}-report.md
Think (Coverage dimension): Which apps/modules have feature documentation? Which are missing? What's the distribution — evenly documented or concentrated?
Think (Accuracy dimension): What section headings actually appear across feature docs? What's the frequency? Which sections are standard (≥80% coverage) vs optional (20-80%) vs rare (<20%)?
Think (Completeness dimension): Are there documentation naming patterns? Section numbering? Required fields (evidence fields, TC IDs, CHANGELOG)?
docs/**/*.md to map full documentation treeThink (Relationships dimension): Which frontend apps map to which backend services? Where is this documented vs inferred? Which apps have no service mapping?
Think (Conventions dimension): What naming, numbering, and tagging conventions appear consistently? Are TC IDs present? What format?
Read report. Apply fresh-eyes protocol:
Round 1 (main agent): Build section drafts.
Round 2 (fresh sub-agent, zero memory):
| Section | Content |
|---|---|
| App-to-Service Mapping | Table: App name, Backend services, Doc directory, Doc count |
| Directory Structure | Tree showing docs/ organization with purpose annotations |
| Template Paths | Table: Template name, Path, Purpose, Used by N docs |
| Section Structure | Standard sections across feature docs (with frequency table) |
| Documentation Conventions | Naming, numbering, required fields, evidence rules |
| Coverage Gaps | Apps/services without documentation, incomplete docs |
<!-- Last scanned: YYYY-MM-DD --> at topdocs/business-features/{Module}/detailed-features/README.{FeatureName}.md — feature doc template.claude/skills/feature-docs/SKILL.md — feature doc generation skill.claude/skills/shared/tc-format.md — canonical TC format[IMPORTANT] Use task tracking to break ALL work into small tasks BEFORE starting — including tasks per file read. Prevents context loss from long files. Simple tasks: ask user whether to skip.
Prerequisites: MUST ATTENTION READ before executing:
Output note: This skill's primary output (
feature-docs-reference.md) MUST include the actual directory tree — it is the source of truth for doc locations. This is intentionally different from spec output documents which suppress directory trees.
AI Mistake Prevention — Failure modes to avoid:
Verify AI-generated content against actual code. AI hallucinates file paths and section headings. Glob to confirm existence before documenting. Trace full dependency chain after edits. Always trace full chain. Surface ambiguity before coding. NEVER pick silently. Check downstream references before deleting. Map referencing files before removal.
Critical Thinking Mindset — Every claim needs traced proof, confidence >80% to act. Anti-hallucination: Never present guess as fact — cite sources, admit uncertainty, self-check output, cross-reference independently. Certainty without evidence = root of all hallucination.
Scan & Update Reference Doc — Surgical updates only, NEVER full rewrite.
- Read existing doc first — understand structure and manual annotations
- Detect mode: Placeholder (headings only) → Init. Has content → Sync.
- Scan codebase (grep/glob) for current state
- Diff findings vs doc — identify stale sections only
- Update ONLY diverged sections. Preserve manual annotations.
- Update metadata (date, version) in frontmatter/header
- NEVER rewrite entire doc. NEVER remove sections without evidence obsolete.
MUST ATTENTION apply critical thinking — every claim needs traced proof, confidence >80% to act. Anti-hallucination: never present guess as fact.
MUST ATTENTION apply AI mistake prevention — holistic-first debugging, fix at responsible layer, surface ambiguity before coding, re-read files after compaction.
file:line evidence for every claim (confidence >80% to act)Anti-Rationalization:
| Evasion | Rebuttal |
|---|---|
| "Mode obvious, skip Phase 0 detection" | Phase 0 mode detection is BLOCKING — INIT vs SYNC paths differ significantly |
| "Coverage Gaps not needed" | Coverage Gaps is a required section — omitting it hides maintenance debt |
| "Template paths probably exist" | Verify all 3 template paths exist before writing — "probably" ≠ verified |
| "App-service mapping looks right" | Verify mappings match actual directory structure via glob |
| "Skip Round 2 even when Round 1 found issues" | Clean Round 1 ends the scan. When issues exist, fresh-eyes mandatory after fixing — main agent rationalizes own section extractions. |
[TASK-PLANNING] Before acting, analyze task scope and break into small todo tasks and sub-tasks using task tracking.
Source: .claude/hooks/lib/prompt-injections.cjs + .claude/.ck.json
$workflow-start <workflowId> for standard; sequence custom steps manually[CRITICAL] Hard-won project debugging/architecture rules. MUST ATTENTION apply BEFORE forming hypothesis or writing code.
Goal: Prevent recurrence of known failure patterns — debugging, architecture, naming, AI orchestration, environment.
Top Rules (apply always):
ExecuteInjectScopedAsync for parallel async + repo/UoW — NEVER ExecuteUowTaskwhere python/where py) — NEVER assume python/python3 resolvesExecuteInjectScopedAsync, NEVER ExecuteUowTask. ExecuteUowTask creates new UoW but reuses outer DI scope (same DbContext) — parallel iterations sharing non-thread-safe DbContext silently corrupt data. ExecuteInjectScopedAsync creates new UoW + new DI scope (fresh repo per iteration).AccountUserEntityEventBusMessage = Accounts owns). Core services (Accounts, Communication) are leaders. Feature services (Growth, Talents) sending to core MUST use {CoreServiceName}...RequestBusMessage — never define own event for core to consume.HrManagerOrHrOrPayrollHrOperationsPolicy names set members, not what it guards. Add role → rename = broken abstraction. Rule: names express DOES/GUARDS, not CONTAINS. Test: adding/removing member forces rename? YES = content-driven = bad → rename to purpose (e.g., HrOperationsAccessPolicy). Nuance: "Or" fine in behavioral idioms (FirstOrDefault, SuccessOrThrow) — expresses HAPPENS, not membership.python/python3 resolves — verify alias first. Python may not be in bash PATH under those names. Check: where python / where py. Prefer py (Windows Python Launcher) for one-liners, node if JS alternative exists.Test-specific lessons →
docs/project-reference/integration-test-reference.mdLessons Learned section. Production-code anti-patterns →docs/project-reference/backend-patterns-reference.mdAnti-Patterns section. Generic debugging/refactoring reminders → System Lessons in.claude/hooks/lib/prompt-injections.cjs.
ExecuteInjectScopedAsync, NEVER ExecuteUowTask (shared DbContext = silent data corruption){CoreServiceName}...RequestBusMessagepython/python3 resolves — run where python/where py first, use py launcher or nodeBreak work into small tasks (task tracking) before starting. Add final task: "Analyze AI mistakes & lessons learned".
Extract lessons — ROOT CAUSE ONLY, not symptom fixes:
$learn.$code-review/$code-simplifier/$security/$lint catch this?" — Yes → improve review skill instead.$learn.
[TASK-PLANNING] [MANDATORY] BEFORE executing any workflow or skill step, create/update task tracking for all planned steps, then keep it synchronized as each step starts/completes.