Prompt file imported from SkyDominator/simulation (.github/prompts/privacy-policy/spec/examples/1-review.prompt.md). Copyright stays with the author.

Software Specification Document Review

Name: 1-review
Author: SkyDominator

Read thoroughly the following review areas and review the Software Specification Document (SSD) /.memo/CE/specs/myapp_SSD.md. Provide feedback on any areas that require improvement or further clarification.

Review Areas

Background

A Software Specification Document (SSD) is a comprehensive technical document that defines the requirements, architecture, and implementation details for a software system. As of 2025, SSDs have evolved to be:

Living documents that integrate with CI/CD pipelines and are auto-generated from source code
API-first specifications often tied to OpenAPI schemas and contract testing
Security-conscious with threat modeling and compliance requirements built-in
Cloud-native aware with considerations for microservices, containers, and managed services
Accessibility and internationalization ready from the start

SSD Coverage Guidelines

Coverage Width

Functional Requirements (what the system does)
- UX flows
- User roles and permissions
- Data models and relationships
Non-functional Requirements (performance, security, scalability)
API Contracts and data models
Architecture and system design
Security and authentication flows
Error handling and validation
Deployment and operational considerations

Coverage Depth

High-level for stakeholder alignment
Medium-detail for implementation guidance
Deep-detail only for critical/complex components
Reference links to detailed implementation docs

The most important question to ask:

Does it fit to the Goals & Environments?

Does the SSD align with the project goals?
Does the SSD exactly match the app environments (e.g., target devices, target OS, target web browsers, target users, etc.)? The SSD should scale exactly, not including over-engineering nor under-engineering.

Review format

Write your review as /.memo/CE/specs/myapp_SSD_review-020.md (SSD Review (v0.2.0)). Include suggestions for improvements or changes where necessary for each key review area.

# Software Specification Document Review Read thoroughly the following review areas and review the Software Specification Document (SSD) `/.memo/CE/specs/myapp_SSD.md`. Provide feedback on any areas that require improvement or further clarification. # Review Areas ## Background A Software Specification Document (SSD) is a comprehensive technical document that defines the requirements, architecture, and implementation details for a software system. As of 2025, SSDs have evolved to be: * Living documents that integrate with CI/CD pipelines and are auto-generated from source code * API-first specifications often tied to OpenAPI schemas and contract testing * Security-conscious with threat modeling and compliance requirements built-in * Cloud-native aware with considerations for microservices, containers, and managed services * Accessibility and internationalization ready from the start ## SSD Coverage Guidelines ### Coverage Width * Functional Requirements (what the system does) * UX flows * User roles and permissions * Data models and relationships * Non-functional Requirements (performance, security, scalability) * API Contracts and data models * Architecture and system design * Security and authentication flows * Error handling and validation * Deployment and operational considerations ### Coverage Depth * High-level for stakeholder alignment * Medium-detail for implementation guidance * Deep-detail only for critical/complex components * Reference links to detailed implementation docs ### The most important question to ask: *Does it fit to the Goals & Environments?* 1. Does the SSD align with the project goals? 2. Does the SSD exactly match the app environments (e.g., target devices, target OS, target web browsers, target users, etc.)? The SSD should scale exactly, not including over-engineering nor under-engineering. ## Review format Write your review as `/.memo/CE/specs/myapp_SSD_review-020.md` (SSD Review (v0.2.0)). Include suggestions for improvements or changes where necessary for each key review area.

{ "prompt": "# Software Specification Document Review\n\nRead thoroughly the following review areas and review the Software Specification Document (SSD) `/.memo/CE/specs/myapp_SSD.md`. Provide feedback on any areas that require improvement or further clarification.\n\n# Review Areas\n\n## Background\n\nA Software Specification Document (SSD) is a comprehensive technical document that defines the requirements, architecture, and implementation details for a software system. As of 2025, SSDs have evolved to be:\n\n* Living documents that integrate with CI/CD pipelines and are auto-generated from source code\n* API-first specifications often tied to OpenAPI schemas and contract testing\n* Security-conscious with threat modeling and compliance requirements built-in\n* Cloud-native aware with considerations for microservices, containers, and managed services\n* Accessibility and internationalization ready from the start\n\n## SSD Coverage Guidelines\n\n### Coverage Width\n\n* Functional Requirements (what the system does)\n * UX flows\n * User roles and permissions\n * Data models and relationships\n* Non-functional Requirements (performance, security, scalability)\n* API Contracts and data models\n* Architecture and system design\n* Security and authentication flows\n* Error handling and validation\n* Deployment and operational considerations\n\n### Coverage Depth\n\n* High-level for stakeholder alignment\n* Medium-detail for implementation guidance\n* Deep-detail only for critical/complex components\n* Reference links to detailed implementation docs\n\n\n### The most important question to ask:\n\n*Does it fit to the Goals & Environments?*\n\n1. Does the SSD align with the project goals?\n2. Does the SSD exactly match the app environments (e.g., target devices, target OS, target web browsers, target users, etc.)? The SSD should scale exactly, not including over-engineering nor under-engineering.\n\n## Review format\n\nWrite your review as `/.memo/CE/specs/myapp_SSD_review-020.md` (SSD Review (v0.2.0)). Include suggestions for improvements or changes where necessary for each key review area.", "variables": [], "notes": "Read thoroughly the following review areas and review the Software Specification Document (SSD) `/.memo/CE/specs/myapp_SSD.md`. Provide feedback on any areas that require improvement or further clarification. Mode: agent. Tools: codebase, usages, problems, fetch, searchResults, githubRepo, editFiles, search, context7, pylance mcp server, getPythonEnvironmentInfo, getPythonExecutableCommand.", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/SkyDominator/simulation", "path": ".github/prompts/privacy-policy/spec/examples/1-review.prompt.md", "ref": "ae272ed71b7687b26110c0f363f01d4963e13903", "url": "https://github.com/SkyDominator/simulation/blob/ae272ed71b7687b26110c0f363f01d4963e13903/.github/prompts/privacy-policy/spec/examples/1-review.prompt.md", "key": "SkyDominator/simulation/.github/prompts/privacy-policy/spec/examples/1-review.prompt.md" } } }

1-review

About

Software Specification Document Review

Review Areas

Background

SSD Coverage Guidelines

Coverage Width

Coverage Depth

The most important question to ask:

Review format

Use it

Manifest

Reviews