Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions document-feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Document review commands
carefully perform a review about technical specifications, API details if any on $ARGUMENTS.

## Process
- Review will be done for two entities i.e developer and user of the project.
- Analyze the revelant code files
- Run the project and check endpoints
- Take required screenshots for user documentation
- Auto-link to related existing documentation


## Output Requirements
- Save review for developer as 'docs/dev/{filename}.review.md' and for user as 'docs/user/{filename}.review.md'
- rate overall quality excellent/Good/Need Improvements
- Estimate refactoring Low/Medium/High
- Include placeholders for screenshots in user docs