110 lines
4.7 KiB
HTML
110 lines
4.7 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>ln-111-root-docs-creator - State Diagram</title>
|
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js"></script>
|
|
<link rel="stylesheet" href="../shared/css/diagram.css">
|
|
</head>
|
|
<body>
|
|
<div class="container">
|
|
<header>
|
|
<h1>📝 ln-111-root-docs-creator</h1>
|
|
<p class="subtitle">Root Documentation Creator - State Diagram</p>
|
|
</header>
|
|
|
|
<div class="info-box">
|
|
<h3>📋 Workflow Overview</h3>
|
|
<ul>
|
|
<li><strong>Purpose:</strong> Create root documentation entry points (CLAUDE.md + docs/README.md + documentation_standards.md + principles.md)</li>
|
|
<li><strong>Worker for:</strong> ln-110-documents-pipeline orchestrator</li>
|
|
<li><strong>Phases:</strong> 3 phases (Phase 1 CREATE → Phase 2 Structure Validation → Phase 3 Semantic Content Validation)</li>
|
|
<li><strong>Validation:</strong> Phase 2/3 validation with questions.md (22 questions for 4 documents)</li>
|
|
<li><strong>Idempotent:</strong> Can be run multiple times safely</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="legend">
|
|
<div class="legend-item">
|
|
<div class="legend-color color-action"></div>
|
|
<span>Creation Action</span>
|
|
</div>
|
|
<div class="legend-item">
|
|
<div class="legend-color color-decision"></div>
|
|
<span>Conditional Check</span>
|
|
</div>
|
|
<div class="legend-item">
|
|
<div class="legend-color color-success"></div>
|
|
<span>Success State</span>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="diagram-container">
|
|
<div class="mermaid">
|
|
graph TD
|
|
Start([Start: Root Docs Creation]) --> Phase1{CLAUDE.md exists?}
|
|
|
|
Phase1 -->|Yes| CheckLink{Has docs/README.md<br/>link?}
|
|
Phase1 -->|No| AskProject[Ask: Project name<br/>and description]
|
|
|
|
CheckLink -->|Yes| Phase2Start[Phase 2: Create docs/README.md]
|
|
CheckLink -->|No| AddLink[Add docs link<br/>to CLAUDE.md]
|
|
|
|
AskProject --> CreateClaude[Create CLAUDE.md<br/>from template]
|
|
CreateClaude --> CreateStandards[Create documentation_standards.md<br/>60 universal requirements]
|
|
CreateStandards --> CreatePrinciples[Create principles.md<br/>11 development principles]
|
|
CreatePrinciples --> Phase2Start
|
|
AddLink --> Phase2Start
|
|
|
|
Phase2Start --> CreateDir[Create docs/<br/>directory]
|
|
CreateDir --> CreateReadme[Create docs/README.md<br/>from template]
|
|
CreateReadme --> ReplaceVars[Replace placeholders:<br/>VERSION, DATE, STATUS]
|
|
ReplaceVars --> Phase2Validate[Phase 2: Structure Validation<br/>SCOPE tags, Maintenance sections]
|
|
Phase2Validate --> Phase3Validate[Phase 3: Semantic Content Validation<br/>questions.md Q1-Q22]
|
|
Phase3Validate --> Notify[Notify: Root structure<br/>established + validated]
|
|
|
|
Notify --> End([End: ✓ 4 docs created + validated])
|
|
|
|
%% Styling
|
|
classDef action fill:#C8E6C9,stroke:#388E3C,stroke-width:2px
|
|
classDef decision fill:#FFE0B2,stroke:#E64A19,stroke-width:2px
|
|
classDef success fill:#B3E5FC,stroke:#0277BD,stroke-width:2px
|
|
|
|
class AskProject,CreateClaude,CreateStandards,CreatePrinciples,AddLink,CreateDir,CreateReadme,ReplaceVars,Phase2Validate,Phase3Validate,Notify action
|
|
class Phase1,CheckLink decision
|
|
class End success
|
|
</div>
|
|
</div>
|
|
|
|
<div class="info-box">
|
|
<h3>🔑 Key Features</h3>
|
|
<ul>
|
|
<li><strong>First Worker:</strong> Establishes documentation structure and standards</li>
|
|
<li><strong>Idempotent:</strong> Skips if CLAUDE.md already has docs link</li>
|
|
<li><strong>Template-Based:</strong> Uses claude_md_template.md, docs_root_readme_template.md, documentation_standards_template.md, principles_template.md</li>
|
|
<li><strong>General Standards:</strong> docs/README.md contains SCOPE Tags, Maintenance Sections, Writing Guidelines</li>
|
|
<li><strong>Semantic Validation:</strong> Parametric validation loop with questions.md (Q1-Q22)</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<footer>
|
|
<p>Generated for ln-111-root-docs-creator skill | Version 10.0.0</p>
|
|
<p>Diagram format: Mermaid.js | Last updated: 2025-11-18</p>
|
|
</footer>
|
|
</div>
|
|
|
|
<script>
|
|
mermaid.initialize({
|
|
startOnLoad: true,
|
|
theme: 'default',
|
|
flowchart: {
|
|
useMaxWidth: true,
|
|
htmlLabels: true,
|
|
curve: 'basis'
|
|
}
|
|
});
|
|
</script>
|
|
</body>
|
|
</html>
|