Created
December 29, 2024 22:04
-
-
Save boxabirds/2892a2bc4aa3c087b8e8d31564572073 to your computer and use it in GitHub Desktop.
Coding Agent prompt for review & retrospective documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
At this point I want you to create a design doc that describes the following things. The things below are to be made into separate .md files in a doc/ directory. | |
mermaid diagrams showing the key objects and their relationships | |
mermaid sequence diagram showing key interactions for the main use cases | |
summarise the agent journey so far: review the entire chat history and highlight the things that were easy to implement (one prompt => feature) and things that were very hard to implement | |
following this, create a maintenance guide whose sole objective is to help the next contributors to the code base. It should explain the frameworks and services used, the components, and notes on anything about the implementation that may not be obvious to someone even if they have experience with the framework used. | |
finally summarise areas that need to be developed to turn this into a proper product that can be supported, maintained and expanded.E.g. logging, telemetry, security considerations etc. | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment