Write a project guide with AI
Organise Markdown documentation around a reader’s task and show how they can tell whether each command worked.
Write a project guide with AI by choosing the moment someone opens it. A new colleague trying to generate their first sample report wants a short route to a result. A maintainer called in after a failed job needs symptoms and checks. The markdown-docs skill helps an agent choose the appropriate document for each reader.
A usable command includes the assumptions its author usually forgets to mention. Which directory should it run from? Where does the example value come from? What should appear on screen? Answering those questions makes the guide easier to verify after a project update.
What it does
- Separate a quickstart from a reference or troubleshooting runbook.
- Put the reader’s first useful action near the beginning.
- Include complete commands and explain any placeholders.
- Describe the expected output or other signs of success.
- Keep frequently changing facts in one maintained location.
Install and use
- Give a text-capable agent the permitted project notes, the intended reader and one real task. To validate commands, use an appropriate authorised project environment.
- Ask, “Write the first-run guide for producing a sample report. Say where each command runs and what file should appear afterwards.”
- Walk through the guide from a clean starting point and check for missing assumptions.
FAQ
Source
Made by Arjun Prabhulal. Original skill: markdown-docs, published on GitHub under the MIT licence.
View on GitHub