Automated ingestion of prompt: prd-and-technical-documentation-generator
This commit is contained in:
parent
bbb06d8503
commit
3cc96b24f7
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
title: "prd-and-technical-documentation-generator"
|
||||
contributor: "@tcyjg"
|
||||
tags: #general, #tcyjg
|
||||
---
|
||||
|
||||
---
|
||||
name: prd-and-technical-documentation-generator
|
||||
description: A skill for generating comprehensive Product Requirements Documents (PRDs) and technical documentation for projects.
|
||||
---
|
||||
|
||||
# PRD and Technical Documentation Generator
|
||||
|
||||
This skill is designed to assist in the creation of detailed Product Requirements Documents (PRDs) and accompanying technical documentation.
|
||||
|
||||
## Instructions
|
||||
|
||||
1. **Define the Product or Feature**: Clearly specify the product or feature for which the documentation is being created.
|
||||
2. **Gather Requirements**: Identify and list all necessary requirements, including functional and non-functional aspects.
|
||||
3. **Structure the PRD**:
|
||||
- **Introduction**: Provide a brief overview of the product or feature.
|
||||
- **Problem Statement**: Describe the problem the product or feature aims to solve.
|
||||
- **Objectives**: Outline the main goals and objectives.
|
||||
- **Scope**: Define the scope, including what is included and excluded.
|
||||
- **Requirements**: Detail functional and non-functional requirements.
|
||||
- **User Stories**: Include user stories to illustrate usage scenarios.
|
||||
4. **Technical Documentation**:
|
||||
- **Architecture Overview**: Provide an architectural diagram and description.
|
||||
- **Technical Specifications**: Detail the technical requirements and specifications.
|
||||
- **APIs and Interfaces**: List APIs and interfaces, including usage and examples.
|
||||
- **Security and Compliance**: Outline security measures and compliance requirements.
|
||||
|
||||
## Examples
|
||||
|
||||
- **Example Input**: "Create a PRD for a new e-commerce platform feature"
|
||||
- **Example Output**: A structured document with all sections populated with relevant information.
|
||||
|
||||
## Variables
|
||||
|
||||
- ${productFeature} - The specific product feature or initiative.
|
||||
- ${documentType:PRD} - Type of document to generate (PRD or Technical).
|
||||
|
||||
Utilize this skill to efficiently produce comprehensive documentation that supports project objectives and stakeholder needs.
|
||||
Loading…
Reference in New Issue