docs-organization

Organizes project documentation into a categorized /docs tree with a clean repository root.

1|Updated Jun 3, 2026
One-click install
npx skills add https://github.com/tanveerriaz/Skillz --skill docs-organization-tanveerriaz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-organization
Source: https://github.com/tanveerriaz/Skillz/tree/main/skills/docs-organization
Command: npx skills add https://github.com/tanveerriaz/Skillz --skill docs-organization-tanveerriaz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Markdown and SQL files tend to accumulate in the repository root and random subfolders, making documentation impossible to navigate. This Skill centralizes all docs under a single /docs tree with predictable category subfolders and enforces a strict root-folder policy. ## Core Features & Use Cases - Categorized Placement: Routes documents into subfolders like docs/deployment/, docs/setup/, docs/troubleshooting/, docs/security/, docs/migration/, docs/reviews/, docs/roadmaps/, and docs/database/ based on purpose. - Root Hygiene Enforcement: Limits the project root to README, LICENSE, and CHANGELOG, preventing stray markdown and SQL files. - Index Maintenance: Keeps a navigable docs/README.md index updated as the structure changes. - Use Case: When adding a new Railway deployment guide, the Skill places it at docs/deployment/railway-setup.md with a lowercase-hyphenated name and updates the docs index instead of dropping DEPLOY.md in the root. ## Quick Start Organize this project's scattered markdown and SQL files into a categorized /docs folder structure and clean up the repository root.

Frequently Asked Questions about docs-organization

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

FAQPage Schema
How do I organize documentation files in a software project?▼

Place all documentation under a single /docs directory with category subfolders such as deployment, setup, troubleshooting, security, migration, reviews, roadmaps, and database. Keep the project root limited to README, LICENSE, and CHANGELOG, and maintain a docs/README.md index for navigation.

Where should SQL migration files go in a repository?▼

Database schemas belong in docs/database/schemas/ and database migrations in docs/database/migrations/. An exception applies when a SQL file is actively used by a script, in which case it may stay alongside that script.

What files are allowed in a project root directory?▼

Only README.md, LICENSE, and CHANGELOG.md belong in the project root under this policy. All other markdown and SQL files should be moved into the appropriate /docs subfolder to keep the root clean.

Does this docs structure work in a monorepo?▼

Yes, each package in a monorepo may have its own docs/ folder for package-specific documentation. Project-wide documentation still goes in the root-level docs/ directory.

What if a tool requires a file in a fixed location like CONTRIBUTING.md?▼

The tool's convention takes priority over the docs policy. Files that external tools expect at fixed paths, such as CONTRIBUTING.md, should remain where the tool requires them.