file-placement

Enforce documentation and script file placement into designated project subdirectories.

2|1|Updated May 27, 2025

Search Tags:#documentation #file organization #developer workflow #enforcement #code structure #script management

Ready to run

npx skills add https://github.com/PAIPalooza/chicommerce --skill file-placement-paipalooza

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: file-placement
Source: https://github.com/PAIPalooza/chicommerce/tree/main/.ainative/skills/file-placement
Command: npx skills add https://github.com/PAIPalooza/chicommerce --skill file-placement-paipalooza

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill prevents project disorganization and developer frustration by enforcing strict rules for where documentation and script files can be created, ensuring a clean and maintainable project structure.

Core Features & Use Cases

Zero Tolerance Enforcement: Prevents .md files from being created in root directories (except specific exceptions like README.md) and .sh scripts from being placed in backend directories (except start.sh).
Mandatory Subfolders: Directs all documentation to docs/ subfolders and all scripts to the scripts/ folder, categorized by filename patterns.
Use Case: When a developer is about to create a new bug report .md file, this Skill will ensure it's placed in docs/issues/ instead of the project root, maintaining order.

Quick Start

Use the file-placement skill to ensure any new markdown file is placed in the correct documentation subfolder.

Frequently Asked Questions about file-placement

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

FAQPage Schema

How do I enforce strict file placement rules for documentation and scripts in a project repository?▼

Enforce strict file placement by mandating all markdown files go into `docs/` subdirectories and executable scripts into `scripts/`, preventing root directory clutter. This ensures maintainable project structure and discoverability by disallowing files in root directories except designated exceptions like `README.md` and `start.sh`.

What's the best way to keep markdown documentation files out of the project root directory?▼

Keep markdown files out of the root directory by directing all documentation to `docs/` subfolders categorized by filename patterns. This file organization approach enforces zero tolerance for root-level `.md` files except specific exceptions like `README.md`, maintaining a clean project structure.

Can I use filename patterns to categorize scripts and documentation in subdirectories?▼

Yes, you can categorize scripts and documentation in subdirectories using defined filename patterns. This file organization method routes executable scripts to the `scripts/` folder and documentation to `docs/` subfolders, ensuring files are discoverable and properly structured within the project repository.

Does this file organization approach allow exceptions for specific files like README.md?▼

Yes, this file placement enforcement allows specific exceptions such as `README.md` in root directories and `start.sh` in backend directories. All other markdown files must be placed in `docs/` subfolders and executable scripts in the `scripts/` folder to prevent project disorganization.

Why does my developer workflow require mandatory subfolders for scripts and documentation?▼

Your developer workflow requires mandatory subfolders to prevent project disorganization and developer frustration. By enforcing that all scripts go to `scripts/` and documentation to `docs/`, you ensure a clean, maintainable code structure where files are easily discoverable and correctly categorized.