feature-docs

Use when the user asks to generate comprehensive feature documentation with verified test cases, create feature README with code evidence, or document a complete feature with test verification. Triggers on keywords like "feature documentation", "document feature", "comprehensive docs", "feature README", "test verification", "verified documentation".

allowed_tools: Read, Write, Edit, Bash, Grep, Glob, Task, TodoWrite

$ 安裝

git clone https://github.com/duc01226/EasyPlatform /tmp/EasyPlatform && cp -r /tmp/EasyPlatform/.github/skills/feature-docs ~/.claude/skills/EasyPlatform

// tip: Run this command in your terminal to install the skill


name: feature-docs description: Use when the user asks to generate comprehensive feature documentation with verified test cases, create feature README with code evidence, or document a complete feature with test verification. Triggers on keywords like "feature documentation", "document feature", "comprehensive docs", "feature README", "test verification", "verified documentation". allowed-tools: Read, Write, Edit, Bash, Grep, Glob, Task, TodoWrite

Feature Documentation Generation & Verification

Generate comprehensive feature documentation following the GOLD STANDARD template pattern.

GOLD STANDARD Reference: docs/features/README.ExampleFeature1.md (Example App) Template File: docs/templates/detailed-feature-docs-template.md


MANDATORY 26-SECTION STRUCTURE

All feature documentation MUST follow this section order:

#SectionStakeholder Focus
1Executive SummaryPO, BA
2Business ValuePO, BA
3Business RequirementsPO, BA
4Business RulesBA, Dev
5Process FlowsBA, Dev, Architect
6Design ReferenceBA, UX, Dev
7System DesignDev, Architect
8ArchitectureDev, Architect
9Domain ModelDev, Architect
10API ReferenceDev, Architect
11Frontend ComponentsDev
12Backend ControllersDev
13Cross-Service IntegrationDev, Architect
14Security ArchitectureDev, Architect
15Performance ConsiderationsDev, Architect, DevOps
16Implementation GuideDev
17Test SpecificationsQA
18Test Data RequirementsQA
19Edge Cases CatalogQA, Dev
20Regression ImpactQA
21TroubleshootingDev, QA, DevOps
22Operational RunbookDevOps
23Roadmap and DependenciesPO, BA
24Related DocumentationAll
25GlossaryPO, BA
26Version HistoryAll

Phase 1: Feature Analysis

Build knowledge model in ai_task_analysis_notes/[feature-name].ai_task_analysis_notes_temp.md.

Discovery Areas

  1. Domain Entity Discovery: Entities, value objects, enums
  2. Workflow Discovery: Commands, Queries, Event Handlers, Background Jobs
  3. API Discovery: Controllers, endpoints, DTOs
  4. Frontend Discovery: Components, Services, Stores
  5. Cross-Service Discovery: Message Bus messages, producers, consumers

Phase 2: Documentation Generation

Generate at docs/business-features/{Module}/detailed-features/README.{FeatureName}.md.

Key Format Examples

Business Requirements (FR-XX):

#### FR-{MOD}-01: {Requirement Title}

| Aspect          | Details                                 |
| --------------- | --------------------------------------- |
| **Description** | {What this requirement enables}         |
| **Scope**       | {Who can use / affected entities}       |
| **Evidence**    | `{FilePath}:{LineRange}`                |

User Stories (US-XX):

#### US-{MOD}-01: {Story Title}

**As a** {role}
**I want** {goal/desire}
**So that** {benefit/value}

**Acceptance Criteria**:
- [ ] AC-01: {Criterion with evidence reference}
- [ ] AC-02: {Criterion with evidence reference}

**Related Requirements**: FR-{MOD}-01, FR-{MOD}-02
**Evidence**: `{FilePath}:{LineRange}`

Test Summary Table (MANDATORY):

| Category               | P0 (Critical) | P1 (High) | P2 (Medium) | P3 (Low) | Total |
| ---------------------- | :-----------: | :-------: | :---------: | :------: | :---: |
| {Category1}            | {N}           | {N}       | {N}         | {N}      | {N}   |
| **Total**              | **{N}**       | **{N}**   | **{N}**     | **{N}**  | **{N}**|

Test Case Format (TC-XX):

#### TC-{MOD}-001: {Test Name} [P0]

**Acceptance Criteria**:
- ✅ {Passing criteria 1}
- ✅ {Passing criteria 2}

**GIVEN** {initial context}
**WHEN** {action performed}
**THEN** {expected outcome}

**Edge Cases**:
- ❌ {Invalid scenario} → {Expected error/behavior}

**Evidence**: `{FilePath}:{LineRange}`

Troubleshooting Format:

#### {Issue Title}

**Symptoms**: {Observable problem}

**Causes**:
1. {Cause 1}
2. {Cause 2}

**Resolution**:
- {Step 1}
- {Step 2}

Permission Matrix:

| Role | View | Create | Edit | Delete | Special |
|------|:----:|:------:|:----:|:------:|---------|
| Admin | ✅ | ✅ | ✅ | ✅ | Full access |

Phase 3: Verification (2-Pass System)

First Pass

For EACH code reference:

  • Read actual source file at referenced lines
  • Compare character-by-character
  • Verify line numbers are accurate
  • Log mismatches and correct immediately

Second Pass

  • Random sampling (10 code references)
  • Cross-reference and TOC verification
  • Completeness check

CRITICAL: If Second Pass finds MORE THAN 5 issues, HALT and re-run Phase 3.


Anti-Hallucination Protocols

EVIDENCE_CHAIN_VALIDATION

Before claiming any relationship:

  • "I believe X calls Y because..." → show actual code
  • "This follows pattern Z because..." → cite specific examples

DOCUMENTATION_ACCURACY_CHECKPOINT

Before writing any documentation:

  • "Have I read the actual code that implements this?"
  • "Are my line number references accurate and current?"
  • "Can I provide a code snippet as evidence?"

Evidence Verification Protocol (QC)

Verification Summary Table

| Category | Total Claims | Verified | Stale | Missing | Last Verified |
|----------|-------------|----------|-------|---------|---------------|
| Business Requirements | {N} | {N} | {N} | {N} | {Date} |
| Test Specifications | {N} | {N} | {N} | {N} | {Date} |
| **Total** | **{N}** | **{N}** | **{N}** | **{N}** | |

Status Markers

  • ✅ Verified - Line numbers match actual source
  • ⚠️ Stale - Line numbers shifted, content still exists
  • ❌ Missing - Referenced code no longer exists

Quality Checklist

  • All 26 mandatory sections present in correct order
  • Quick Navigation by Role included
  • Executive Summary with key capabilities
  • Business Value with ROI analysis
  • User Stories with acceptance criteria (US-XX format)
  • Business Requirements use FR-{MOD}-XX format
  • Business Rules with state transitions
  • Process Flows with diagrams
  • System Design with technical decisions log
  • Security Architecture with authorization matrix
  • Performance Considerations with targets
  • Implementation Guide with code examples
  • Test Summary table with P0-P3 counts
  • Test Data Requirements and fixtures
  • Edge Cases Catalog (validation, business, concurrency)
  • Regression Impact analysis
  • Test cases use TC-{MOD}-XXX format with GIVEN/WHEN/THEN
  • Acceptance criteria use ✅/❌ markers
  • Troubleshooting uses Symptoms/Causes/Resolution format
  • Operational Runbook with deployment checklist
  • Roadmap and Dependencies
  • Evidence Verification Protocol with audit trail
  • Glossary for non-technical stakeholders
  • Version History table at end
  • All code references verified with actual files