🎯

ln-111-root-docs-creator

🎯Skill

from levnikolaevich/claude-code-skills

VibeIndex|
What it does

Generates standardized root documentation files for a project using templates and context-specific data from a coordinator.

πŸ“¦

Part of

levnikolaevich/claude-code-skills(85 items)

ln-111-root-docs-creator

Installation

Claude CodeAdd plugin in Claude Code
/plugin add levnikolaevich/claude-code-skills
git cloneClone repository
git clone https://github.com/levnikolaevich/claude-code-skills.git ~/.claude/skills
πŸ“– Extracted from docs: levnikolaevich/claude-code-skills
13Installs
-
AddedFeb 4, 2026

Skill Details

SKILL.md

Creates 4 root documentation files (CLAUDE.md, docs/README.md, documentation_standards.md, principles.md). L3 Worker invoked by ln-110-project-docs-coordinator.

Overview

# Root Documentation Creator

L3 Worker that creates 4 root documentation files using templates and Context Store from coordinator.

Purpose & Scope

  • Creates 4 root documentation files (entry points for AI agents)
  • Receives Context Store from ln-110-project-docs-coordinator
  • Replaces placeholders with project-specific data
  • Self-validates structure and content (22 questions)
  • Never gathers context itself; uses coordinator input

Invocation (who/when)

  • ln-110-project-docs-coordinator: ALWAYS invoked as first worker
  • Never called directly by users

Inputs

From coordinator:

  • contextStore: Key-value pairs with all placeholders

- PROJECT_NAME, PROJECT_DESCRIPTION

- TECH_STACK_SUMMARY

- DEV_COMMANDS (from package.json scripts)

- DATE (current date)

- LEGACY_CONTENT (optional, from ln-100 Phase 0 migration):

- legacy_principles: { principles[], anti_patterns[], conventions[] }

  • targetDir: Project root directory

LEGACY_CONTENT is used as base content when creating principles.md. Priority: Legacy > Template defaults.

Documents Created (4)

| File | Target Sections | Questions |

|------|-----------------|-----------|

| CLAUDE.md | Critical Rules, Documentation Navigation, Development Commands, Maintenance | Q1-Q6 |

| docs/README.md | Overview, Standards, Writing Guidelines, Quick Navigation, Maintenance | Q7-Q13 |

| docs/documentation_standards.md | Quick Reference (60+ requirements), 12 main sections, Maintenance | Q14-Q16 |

| docs/principles.md | Core Principles (8), Decision Framework, Anti-Patterns, Verification, Maintenance | Q17-Q22 |

Workflow

Phase 1: Receive Context

  1. Parse Context Store from coordinator
  2. Validate required keys present (PROJECT_NAME, PROJECT_DESCRIPTION)
  3. Set defaults for missing optional keys

Phase 2: Create Documents

For each document (CLAUDE.md, docs/README.md, documentation_standards.md, principles.md):

  1. Check if file exists (idempotent)
  2. If exists: skip with log
  3. If not exists:

- Copy template from references/templates/

- Check LEGACY_CONTENT for this document type:

- For principles.md: If LEGACY_CONTENT.legacy_principles exists:

- Use legacy_principles.principles[] as base for "## Core Principles" section

- Use legacy_principles.anti_patterns[] for "## Anti-Patterns" section

- Use legacy_principles.conventions[] for code style rules

- Augment with template structure (add missing sections)

- Mark: at top of relevant sections

- For other documents: Use template as-is (no legacy content applicable)

- Replace {{PLACEHOLDER}} with Context Store values

- Mark [TBD: X] for missing data (never leave empty placeholders)

- Write file

Phase 3: Self-Validate

For each created document:

  1. Check SCOPE tag in first 10 lines
  2. Check required sections (from questions_root.md)
  3. Check Maintenance section (Update Triggers, Verification, Last Updated)
  4. Check POSIX endings (single newline at end)
  5. Auto-fix issues where possible

Phase 4: Return Status

Return to coordinator:

```json

{

"created": ["CLAUDE.md", "docs/README.md", ...],

"skipped": [],

"tbd_count": 3,

"validation": "OK"

}

```

Critical Notes

Core Rules

  • Idempotent: Never overwrite existing files; skip and log
  • No context gathering: All data comes from coordinator's Context Store
  • TBD markers: Use [TBD: placeholder_name] for missing data, never {{PLACEHOLDER}}
  • Language: All root docs in English (universal standards)
  • SCOPE tags: Required in first 10 lines of each file

NO_CODE_EXAMPLES Rule (MANDATORY)

Root documents define navigation and standards, NOT implementations:

  • FORBIDDEN: Code blocks, implementation snippets
  • ALLOWED: Tables, links, command examples (1 line)
  • TEMPLATE RULE: All templates include tag - FOLLOW IT

Stack Adaptation Rule (MANDATORY)

  • All external links must match project stack (detected in Context Store)
  • .NET project β†’ Microsoft docs; Node.js β†’ MDN, npm docs; Python β†’ Python docs
  • Never mix stack references (no Python examples in .NET project)

Format Priority (MANDATORY)

Tables/ASCII > Lists (enumerations only) > Text (last resort)

Definition of Done

  • Context Store received and validated
  • 4 root documents created (or skipped if exist)
  • All placeholders replaced (or marked TBD)
  • Self-validation passed (SCOPE, sections, Maintenance, POSIX)
  • Status returned to coordinator

Reference Files

  • Templates: references/templates/claude_md_template.md, docs_root_readme_template.md, documentation_standards_template.md, principles_template.md
  • Questions: references/questions_root.md (Q1-Q22)

---

Version: 2.1.0 (Added NO_CODE, Stack Adaptation, Format Priority rules to Critical Notes)

Last Updated: 2025-01-12

More from this repository10

πŸͺ
levnikolaevich-claude-code-skillsπŸͺMarketplace

Official marketplace for Agile Linear Workflow plugin - complete end-to-end automation for software development teams using Linear. Includes 7XX Project Bootstrap series for technology-agnostic project migration.

🎯
ln-140-test-docs-creator🎯Skill

Generates comprehensive test documentation with testing strategy and test organization structure for software projects.

🎯
ln-110-project-docs-coordinator🎯Skill

Coordinates project documentation by gathering context once, detecting project type, and delegating document creation to 5 specialized workers.

🎯
ln-114-frontend-docs-creator🎯Skill

Generates design guidelines documentation for frontend projects with WCAG 2.1 compliance when a frontend framework is detected.

🎯
ln-113-backend-docs-creator🎯Skill

Generates backend documentation files (API spec and database schema) automatically when backend or database technologies are detected in a project.

🎯
ln-610-code-comments-auditor🎯Skill

Audits code comments and docstrings across 6 quality categories, generating a comprehensive compliance score and actionable recommendations for improvement.

🎯
ln-115-devops-docs-creator🎯Skill

Generates a comprehensive runbook.md for DevOps setup, dynamically tailored to project's Docker configuration and deployment specifics.

🎯
ln-772-error-handler-setup🎯Skill

Configures global exception handling middleware for .NET and Python backend applications with standardized error responses.

🎯
ln-120-reference-docs-creator🎯Skill

Generates reference documentation structure and smart documents for project tech stack, creating only justified architectural decision records and guides.

🎯
ln-625-dependencies-auditor🎯Skill

Audits dependencies for outdated packages, unused imports, unnecessary libraries, and custom implementations, providing actionable recommendations.