What is the Hierarchical Aggregation structure?

It is a documentation method where each README only indexes its immediate contents, starting from the CLAUDE.md root down to specific subdirectories, preventing information redundancy.

How does it handle files that don't support comments like JSON?

Files that do not support standardized headers, such as JSON or Markdown, are documented within the parent directory's README instead.

When should I use this skill?

Use it when creating new READMEs, adding standardized headers to source files, refactoring project structures, or performing documentation audits.

Can it detect broken links in my documentation?

Yes, it includes a link validation tool that specifically checks if all internal links within your README files are valid and point to existing files.

Which programming languages are supported for file headers?

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

Document Structure Architect

Name: Document Structure Architect
Author: tarrragon

bytarrragon

0•

Content Management

Standardizes project documentation and file headers using a hierarchical aggregation structure to maintain codebase clarity and consistency.

Document Structure Architect implements a 'Hierarchical Aggregation' strategy to organize project information across CLAUDE.md, directory-level READMEs, and source file headers. It helps developers maintain a professional codebase by providing standardized templates for various programming languages that document a file's position, inputs, outputs, and core responsibilities. Beyond templating, the skill includes automated tools to validate internal documentation links and verify that the project structure adheres to defined standards, significantly reducing the cognitive load for new contributors and maintainers.

Key Features

01Hierarchical README templates for root and sub-directory levels

02Automated internal link validation for README files

030 GitHub stars

04Metadata-driven documentation covering Position, Input, Output, and Responsibility

05Multi-language file header generation for JS, Python, Go, and more

06Project structure integrity checking using Python-based utilities

Use Cases

01Refactoring existing codebases to improve documentation consistency and navigation

02Establishing a standardized documentation hierarchy for new software projects

03Automating the validation of documentation links and structure during development

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