How do you handle documentation?
So in my daily work sometimes I run into brand new code bases that I have zero insights into. And given that I am not a developer by trade, I came up with this prompt and wanted to share it with you all and see what kind of results you got or how we could improve it.
This is intended to map out the entire systems in a folder structure that creates permanent context for the agents, let me know your thoughts!
I’ve used this structure to keep a 97k+ lines of code projects in check, and seems to work pretty well.
Ps not sure why the markdown gets converted to a docx on my iPhone 🤣
.Agents/
└── Technical_Documentation/
├── README_PROJECT_OVERVIEW.md
├── EXISTING_DATA_MODELS.md
├── API_REFERENCE.md
├── ARCHITECTURE_MAP.md
├── DEPLOYMENT_GUIDE.md
├── ONBOARDING_GUIDE.md
└── diagrams/
├── data-flow.md
1
0 comments
Nes M.
3
How do you handle documentation?
Clief Notes
skool.com/quantum-quill-lyceum-1116
Jake Van Clief, giving you the Cliff notes on the new AI age.
Leaderboard (30-day)
Powered by