How does this skill handle non-code files like JSON?

Data-heavy formats like JSON and Markdown are automatically excluded from header requirements and are instead documented within their parent directory's README.

Does it provide tools for maintenance?

Yes, it includes validation scripts (run via uv) to check for broken internal links and ensure that required README files exist throughout the directory tree.

What is the hierarchical convergence structure?

It is a documentation strategy where each README only indexes its immediate sub-level, creating a clean chain of information from the project root to individual files.

Which programming languages are supported for file headers?

The skill includes templates for JavaScript, TypeScript, Python, Dart, Go, HTML, PHP, Java, C#, YAML, and Shell/Bash.

Hierarchical Documentation Manager

Name: Hierarchical Documentation Manager
Author: tarrragon

bytarrragon

0•

内容管理

Standardizes project documentation through a hierarchical convergence structure and automated validation tools.

The Doc Structure skill implements a hierarchical convergence strategy to ensure documentation consistency and eliminate information redundancy across software projects. It manages a structured flow from the root CLAUDE.md through subdirectory READMEs down to individual file headers, focusing on design intent rather than volatile implementation details. The skill provides specialized templates for various directory levels and programming languages, alongside automated scripts to validate internal links and verify structural integrity, making it ideal for maintaining large-scale, readable repositories.

主要功能

01Automated README link validation and structural compliance checking

02Standardized file header generation for over 10 programming languages

03Hierarchical README management for root and subdirectory levels

04Metadata tracking for file positions, dependencies, and responsibilities

050 GitHub stars

06Design-focused documentation principles to minimize maintenance overhead

使用场景

01Refactoring legacy project documentation into a clear, hierarchical structure

02Establishing a standardized documentation framework for new repositories

03Auditing large codebases for broken documentation links and missing headers

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tarrragon/japanese_learning_blog doc-structure

For use in Claude.ai and ChatGPT

Download Skill