diff --git a/document-feature.md b/document-feature.md new file mode 100644 index 0000000..a01fddc --- /dev/null +++ b/document-feature.md @@ -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