new: add LLM prompt for writing requirements.
This commit is contained in:
parent
32a2578826
commit
0a6eb3b919
1 changed files with 35 additions and 0 deletions
|
|
@ -166,3 +166,38 @@ We use a Traceability Matrix to map requirements to other project artifacts.
|
|||
- **Regulatory Awareness:**
|
||||
- Stay informed about regulations relevant to our projects (e.g., GDPR, HIPAA).
|
||||
- Consult with compliance officers when in doubt.
|
||||
|
||||
## LLM Prompt example
|
||||
|
||||
```text
|
||||
When writing requirements, use the following format to clearly articulate the need, the stakeholder’s perspective, the desired outcomes, and the rationale. Adhere strictly to this structure:
|
||||
|
||||
When [condition or situation triggering the requirement],
|
||||
As [stakeholder role],
|
||||
I want [specific actions or outcomes to achieve].
|
||||
This ensures [reason or benefit for implementing the requirement].
|
||||
|
||||
Key Guidelines:
|
||||
1. Condition or Situation: Clearly state when or under what circumstances the requirement applies. Use "When..." to frame this.
|
||||
2. Stakeholder Role: Explicitly identify the stakeholder requesting the requirement. Use "As [stakeholder role]..." to reflect the stakeholder's voice.
|
||||
3. Desired Outcomes: Use "I want..." to specify what the stakeholder expects or desires to be achieved. List actions or outcomes in a concise, actionable manner.
|
||||
4. Rationale: Use "This ensures..." to explain why the requirement is important or what benefit it provides.
|
||||
5. Add a list of relevant acceptance criteria
|
||||
|
||||
Example:
|
||||
When creating or modifying documents,
|
||||
As IT QA CSV representative,
|
||||
I want every document to:
|
||||
- Record the author.
|
||||
- Include timestamps for creation and all modifications.
|
||||
This ensures compliance with the "Attributable" principle of ALCOA+.
|
||||
Acceptance criteria:
|
||||
- The author's name is recorded on every document.
|
||||
- Timestamps are added for document creation and all modifications.
|
||||
|
||||
The input data is:
|
||||
|
||||
Requirement title: Pipeline for configuring Azure DevOps Repos with Ansible
|
||||
Stakeholder: IT Cloud Stream Lead
|
||||
Requirement description: Creation of git repositories should follow a review process and thus team members should never manually create repositories. They should create a branch, add the new repo to a configuration file, and submit a pull request. The pipeline should then create the repository after approval automatically.
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue