Best Practices
Learn about how we at Devscribe best use our agents to create documentation
How we use Devscribe
Our preferred way of using the Devscribe documentation agents is to follow the tips below, and have the mindset of the generated pages being a (very good) first draft.
If you make quality prompts and supply relevant context, the generated documents will be high quality, and then with only one pass for reviewing and editing you will have high quality documentation very quickly for any use case
1. Make a plan for what the documentation should be, before generating
It can be easy to try and offload all thinking onto AI, but this ends up leading to more work and worse outcomes.
Ideally you should know exactly what should be talked about. Tell AI everything you want to be included, and give it the other relevant instructions on how to phrase things, what things need to be stressed, what can be looked over.
Just as if you were telling a Junior Developer what to write. You (hopefully) wouldn't just say "Write docs for this feature"
2. Write Specific Prompts
Detailed prompts produce better results:
3. Provide Targeted Context
Providing context makes a massive difference so please do provide it! It doesnt have to be just files, you can provide general file paths as well to help steer the agent in the right direction.
Select up to 5 relevant files from your repository!