Skip to content

Commit

Permalink
Improve the docu issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
grego952 committed Jul 19, 2024
1 parent 389a03a commit fa0ed67
Showing 1 changed file with 34 additions and 9 deletions.
43 changes: 34 additions & 9 deletions .github/ISSUE_TEMPLATE/documentation-improvement.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,44 @@ about: Suggest an improvement or report a bug in the documentation

**Description**

<!-- Provide a clear and concise description of the potential documentation improvement.-->
<!-- Provide a detailed description of the documentation improvement you are proposing.
Explain WHAT is required and any relevant details.
Try to answer the following questions:
- What areas of the documentation need improvement?
- Are there any specific sections that need to be clarified or added? Provide the link.
- Are there any known constraints or limitations with the current documentation?-->

**Area**
**Reasons**

<!-- Provide the area the document refers to. For example, write:
* Application Connector
* Event Mesh
* Kyma Environment Broker
* Rafter -->
<!-- Explain why this documentation improvement is necessary or beneficial.
Try to answer the following questions:
- How does this documentation improvement benefit users, contributors, or maintainers?
- What specific use cases or scenarios does it address?
- How does it enhance the overall understanding or usability of the project?. -->

**Acceptance Criteria**

<!--
Define the specific requirements that must be met for this documentation improvement to be considered complete.
Use clear, measurable, and testable criteria.
Acceptance criteria might include:
- Clarification of specific concepts or procedures.
- Addition of new examples or use cases.
- Updating outdated information or deprecated features.
Example:
- All installation procedures must be clearly documented with step-by-step instructions.
- Code examples should be added to illustrate usage of new features.
-->

**Reasons**
**Testing Strategy (DoD)**

<!-- Explain why we should improve the document. -->
<!--
Outline the strategy for reviewing and testing this documentation improvement to ensure it meets the acceptance criteria.
Consider what constitutes the "Definition of Done" (DoD).
Include details on:
- Review by technical writers, developers, or contributors for accuracy and clarity.
- Testing the instructions and examples in a real-world or simulated environment.
-->

**Assignees**

Expand Down

0 comments on commit fa0ed67

Please sign in to comment.