QA and docs LLM prompts

14 Mar 2025
💬 EN

TODO

I came across a cool idea for a pair of LLM prompts to help with continuous improvement.

I love how blameless its potential output feels as a conversation piece.

Prompt 1 – helping break through the “writer’s block / blank page problem” with “requirements analysis” part of thinking through QA needs for a frontend:

Analyze the entire frontend codebase of the XYZZY application (frontend repo is at https://…; its corresponding backend repo is available at https://… if you need it to help infer what the frontend does, but the backend is not the focus of this analysis), focusing on the UI components and user interactions. Based on this analysis, please:

1. Infer the likely overall user needs and expected UI flows throughout the application.
2. Identity potential vulnerabilities and areas prone to bugs across the entire UI, considering:
   • data consistency issues (including inconsistencies in data’s rendering)
   • asynchronous operations
   • state management
   • user input handling
   • cross-browser compatibility
   • responsive design issues
3. Suggest 50-200 high-priority unit tests that would cover critical UI behaviors across the entire application, including:
   • key user interactions
   • data display and updates
   • navigation and routing
   • form submissions
   • error handling and edge cases
4. For each suggested test, provide a brief explanation of:
   • the potential issue it addresses
   • its importance in ensuring overall UI reliability and user experience
5. Recommend any structural improvements or design patterns that could enhance the maintainability and testability of the UI components.
6. Identify any areas where additional documentation would be particularly beneficial for future development and maintenance.

Prompt 2 – helping break through the “writer’s block / blank page problem” about documenting an application:

Analyze the entire frontend codebase of the XYZZY application (frontend repo is at https://…; backend repo is at https://…) and generate detailed documentation in multiple versions, each tailored to a specific audience. For each version, provide a clear, well-structured explanation of what the application does, its features, and how it works. Please create the following versions:

1. Executive Summary (for non-technical stakeholders):
   • high-level overview of the application’s purpose and key features
   • business value and user benefits
   • any critical issues or areas for improvement
2. User Guide (for end-users):
   • step-by-step instructions on how to use each feature
   • explanation of the user interface elements
   • troubleshooting tips for common issues
3. Technical Overview (for developers and IT staff):
   • detailed explanation of the application’s architecture
   • description of key components and their interactions
   • technologies used and their versions
   • data flow diagrams and any relevant algorithms
4. API Documentation (if applicable):
   • comprehensive list of all API endpoints
   • request and response formats
   • authentication methods
   • rate limits and error handling
5. Maintenance Guide (for the development team):
   • code structure and organization
   • build and deployment processes
   • known issues and technical debt
   • guidelines for adding new features or making changes
6. Security Analysis (for security teams):
   • potential vulnerabilities identified in the code
   • security measures implemented
   • recommendations for enhancing security

For each version, ensure the documentation is:

• clear, concise, and well-organized
• includes relevant diagrams or flowcharts where appropriate
• highlights any assumptions made during the analysis
• identifies the areas where the code’s intent is unclear and may require further investigation

Please also provide a list of any critical gaps in the codebase that prevent a complete understanding of the application’s functionality.