What is an 'orphan' doc and how does this skill prevent them?

An orphan doc is a file not linked from any other part of the project. This skill requires all new documents to be linked from the README or a parent doc to ensure they are discoverable.

Does this skill help reduce documentation redundancy?

Yes, it explicitly instructs the AI to check existing documentation first and update current files instead of creating new ones if the topic is already covered.

How does this skill handle file naming?

It enforces feature-specific names, such as 'auth-implementation.md' instead of generic names like 'IMPLEMENTATION.md', to improve clarity and searchability.

Where should most documentation be placed using this skill?

Most documentation should be placed in the docs/ directory. The top-level root is reserved for meta and navigation files like README, CHANGELOG, and repo-wide architecture guides.

Documentation Placement Optimizer

Name: Documentation Placement Optimizer
Author: mshuffett

bymshuffett

0•

Learning & Documentation

Organizes and standardizes project documentation by enforcing logical file placement, naming conventions, and structural integrity.

The Documentation Placement skill streamlines project maintenance by providing Claude with a strict framework for managing documentation. It ensures that new content is placed in the appropriate subdirectories rather than cluttering the repository root, enforces descriptive and feature-specific naming conventions, and prevents the creation of 'orphan' pages by requiring links from parent documents. This skill is essential for maintaining a clean, navigable knowledge base in growing software projects by prioritizing the updates of existing docs over redundant creation.

Key Features

010 GitHub stars

02Standardized feature-specific naming conventions

03Redundancy checks to prioritize updating existing content

04Automated document placement enforcement

05Structural separation of meta-navigation and deep guides

06Orphan page prevention through mandatory linking

Use Cases

01Integrating a new feature guide into a complex repository without root clutter.

02Auditing existing documentation to merge redundant files into single sources of truth.

03Ensuring all new technical specifications are properly indexed in the project README.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add mshuffett/dotfiles doc-placement

For use in Claude.ai and ChatGPT

Download Skill