Tidy project documentation with AI
Find conflicting instructions, preserve the details that only appear once and check that readers can still reach a procedure after it moves.
To tidy project documentation with AI, start with a task someone needs to complete. A contributor follows the quick start, reaches the configuration step and discovers a second guide with a different setting. The docs-cleaner skill traces both instructions to the project evidence and asks whether they apply to different environments or whether one has fallen behind.
A consolidation can uncover material that deserves to stay. Two pages might repeat the same command while only one records the order in which two services must start. Keeping that detail is only part of the job. Someone following an old link also needs a route to its new home.
What it does
- Compare different copies of a procedure with the implementation they describe.
- Find distinctive warnings or historical decisions before combining two files.
- Give repeated values a single place to live when readers can refer to it.
- Repair an incoming link after a heading, anchor or file has moved.
- Check what a new contributor sees when entering through the quick start.
Install and use
- Install the skill in a file-capable agent with access to your project. Local search and link-checking tools can help with verification.
- Name the change or folders in scope and say which edits are authorised.
- Review the proposed treatment of unique details, then follow representative links through the final documents.
FAQ
Source
Made by daymade. Original skill: docs-cleaner, published on GitHub under the MIT licence.
View on GitHub