initialize-docs

Scaffold numbered documentation directories with template READMEs from config.json.

21|4|Updated Jan 8, 2026
One-click install
npx skills add https://github.com/JotJunior/claude-ai-tips --skill initialize-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: initialize-docs
Source: https://github.com/JotJunior/claude-ai-tips/tree/main/global/skills/initialize-docs
Command: npx skills add https://github.com/JotJunior/claude-ai-tips --skill initialize-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This skill automates the initialization of a consistent documentation structure for a project, creating numbered directories (01-09), template READMEs, and organized sections (briefing, UCs, DER, ADRs, APIs, tests, operations) to ensure baseline documentation from day one.

Core Features & Use Cases

  • Scaffold the default 01-09 documentation layout with a ready-to-edit README for each folder
  • Respect customizations defined in config.json (docs_dir, structure, keep_in_root, file_routing) when present
  • Provide an idempotent workflow that does not overwrite user content unless --force is used
  • Offer a scripts/scaffold.sh utility for quick, repeatable scaffolding

Quick Start

Run the scaffold script to create the standard docs structure.

Frequently Asked Questions about initialize-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a standard documentation structure for a new project?▼

You scaffold a documentation structure by generating numbered directories (01-09) with template READMEs for sections like briefing, APIs, and operations, establishing baseline project docs from day one.

What's the best way to organize project readmes and documentation folders automatically?▼

The best way to organize documentation folders automatically is by running a scaffolding script that creates a predefined 01-09 directory layout with ready-to-edit READMEs, or applies a custom layout defined in config.json.

Does scaffolding a docs directory overwrite existing project READMEs?▼

Scaffolding a docs directory does not overwrite existing project READMEs. The workflow operates idempotently and only modifies existing READMEs when explicitly asked, unless the --force flag is used.

Can I use a custom project structure instead of the default numbered layout?▼

Yes, you can use a custom project structure by defining your preferred layout in a config.json file. The scaffold script reads customizations like docs_dir, structure, keep_in_root, and file_routing when present.

Why does my documentation scaffolding script keep skipping existing folders?▼

Your documentation scaffolding script skips existing folders because it operates idempotently to protect user content. It reports what was created or moved and avoids overwriting files unless you pass the --force flag.