skills.rest
vivshaw
vivshawCOMMUNITY
Explore all skills by this author →
Website𝕏@vvvivshawGitHub

writing-claude-md-files

Create and maintain CLAUDE.md files with Markdown and YAML.

2|Updated Feb 16, 2026
Search Tags:#software architecture#code organization#project documentation#CLAUDE.md#domain-specific documentation
One-click install
npx skills add https://github.com/vivshaw/nous --skill writing-claude-md-files-vivshaw
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-claude-md-files
Source: https://github.com/vivshaw/nous/tree/main/plugins/meta/skills/writing-claude-md-files
Command: npx skills add https://github.com/vivshaw/nous --skill writing-claude-md-files-vivshaw

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill simplifies the creation and maintenance of CLAUDE.md files, ensuring project organization and preserving architectural intent.

Core Features & Use Cases

  • Project-Wide Documentation: Generates top-level CLAUDE.md files for project-wide information like tech stack and commands.
  • Domain-Level Documentation: Creates domain-specific CLAUDE.md files to outline purpose, contracts, and dependencies.
  • Quick Reference: Provides templates and guidelines for effective CLAUDE.md file creation.
  • Use Case: For a new project, use this Skill to generate a comprehensive CLAUDE.md file that outlines the project's structure, tech stack, and key commands.

Quick Start

Generate a CLAUDE.md file for your project by running 'write-claude-md' in the project root directory.

Frequently Asked Questions about writing-claude-md-files

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

FAQPage Schema
What is a CLAUDE.md file and when do I need project documentation for architectural intent?▼

A CLAUDE.md file documents project organization and preserves architectural intent. You need it for software development projects requiring clear documentation of system architecture and component contracts.

How do I generate a CLAUDE.md file for my project structure?▼

To generate a CLAUDE.md file, run the write-claude-md script in your project root directory. This automates creation of top-level and domain-level documentation using structured Markdown and YAML content.

Can I create domain-specific documentation for separate components in my codebase?▼

Yes, you can create domain-specific documentation. The tool generates domain-level CLAUDE.md files outlining individual component purpose, contracts, and dependencies alongside top-level project-wide documentation.

What is the best way to maintain code organization documentation as a project evolves?▼

The best way to maintain code organization documentation is automating CLAUDE.md file updates to preserve architectural intent. This ensures project documentation consistently reflects top-level structure and domain-level component contracts.

Do I need YAML to document system architecture and component contracts?▼

Yes, the system utilizes YAML alongside Markdown for structured content when creating CLAUDE.md files. This combination effectively outlines your tech stack, system architecture, and component contracts.

Related Skills

Explore More Software Engineering Skills→
telum-aitelum-ai
2

project-import

Create a Speck project structure with a skeleton project.md file.

Official
Basic
KevounCKevounC

design-principles

Enforce and document Ports & Adapters, Single Source of Truth, and Generated Contracts principles.

Community
Advanced
cafe3310cafe3310
248

project-design-concept-organizer

Extract implicit design decisions and architectural concepts from development changes.

Community
Intermediate
RdindaRdinda
1

reversa-arquitetura-3d

Generate standalone interactive 3D HTML visualizations of software architecture from module and dependency inputs.

Community
Advanced