init-docs

Generate profile-aware documentation structures with ADRs, architecture, and deployment templates.

Updated Mar 8, 2026
One-click install
npx skills add https://github.com/aifuun/u-safe-archive --skill init-docs-aifuun
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: init-docs
Source: https://github.com/aifuun/u-safe-archive/tree/main/.claude/skills/init-docs
Command: npx skills add https://github.com/aifuun/u-safe-archive --skill init-docs-aifuun

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Many projects start without a consistent documentation structure, which causes scattered knowledge, missing ADRs, and slow onboarding; init-docs automates creation of a complete, profile-aware docs/ layout so teams have a reproducible starting point.

Core Features & Use Cases

  • Profile-aware initialization: Detects or accepts a profile (tauri, tauri-aws, nextjs-aws) and creates profile-specific directories like docs/desktop, docs/aws, and docs/deployment.
  • Template generation with substitution: Produces README, PRD, ARCHITECTURE, SCHEMA, API, SETUP, TEST_PLAN, DEPLOYMENT and DOCUMENTATION_MANUAL.md with projectName, profile, and techStack substituted.
  • Safe operations and previews: Supports --dry-run for previews, --force for controlled overwrites with backups, --minimal for directories-only mode, and creates an ADR index for architecture decisions.
  • Use case: Rapidly scaffold documentation for a newly initialized Tauri desktop app so product, engineering, and design teams can collaborate from day one.

Quick Start

Run the init-docs command to scaffold a complete docs/ structure for your project with profile-aware templates.

Frequently Asked Questions about init-docs

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

FAQPage Schema
How do I generate standardized project documentation for a new codebase?

To generate standardized project documentation, you can scaffold a complete docs/ layout with profile-aware templates for README, PRD, ARCHITECTURE, and API files. It detects your project profile and substitutes tech stack variables automatically.

What is the best way to create ADRs and architecture docs for a Tauri app?

Creating ADRs and architecture docs for a Tauri app is handled by profile-aware initialization that generates specific directories like docs/desktop and an ADR index. This ensures architecture decisions are tracked automatically.

Can I preview generated documentation templates before writing files to my repository?

Yes, you can preview documentation templates by running initialization with a --dry-run flag. This allows you to inspect the substituted templates and directory structure before any files are written to your project.

Does project documentation generation support existing codebases or only new projects?

Project documentation generation supports both new and existing codebases. It detects your existing profile and safely generates missing templates, using --force to create backups and overwrite existing files when needed.

What happens if a specific documentation template is missing during project initialization?

If a documentation template is missing during project initialization, the process provides a graceful fallback. It continues generating the available standardized structure without failing, ensuring your docs layout is still created.

How do I scaffold only documentation directories without generating template files?

To scaffold only documentation directories without template files, run initialization in --minimal mode. This creates the profile-aware folder structure for your project while skipping the generation of README and API templates.