You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Create and formalize standards for generating and handling tickets related to non-technical documentation. The goal is to ensure consistency, clarity, and understandability across all documentation tasks that cater to non-technical audiences or purposes.
Background:
As the project expands, there is a growing need for non-technical documentation to guide, inform, and communicate with audiences outside of the development team, such as end-users, stakeholders, or new team members. Having a consistent approach to these documentation tasks will make the process more streamlined and effective.
Objective:
Design a set of standards and guidelines for formulating non-technical documentation tickets.
Disseminate and familiarize the team with these standards to ensure uniformity in non-technical documentation tasks.
Success Criteria:
non-technical-documentation-guide.md file is added to docs/contributing/non-technical-documentation-guide.md
Team members have a clear understanding and a standardized approach to non-technical documentation tickets.
skeleton: which headers are required for technical documentation tickets and which content should be included? Which headers are just optional?
Notes:
The aim of these standards is to bridge the gap between technical and non-technical audiences. It's vital to stay adaptable and receptive to changes based on real-world application and feedback.
The text was updated successfully, but these errors were encountered:
Summary:
Create and formalize standards for generating and handling tickets related to non-technical documentation. The goal is to ensure consistency, clarity, and understandability across all documentation tasks that cater to non-technical audiences or purposes.
Background:
As the project expands, there is a growing need for non-technical documentation to guide, inform, and communicate with audiences outside of the development team, such as end-users, stakeholders, or new team members. Having a consistent approach to these documentation tasks will make the process more streamlined and effective.
Objective:
Success Criteria:
non-technical-documentation-guide.md
file is added todocs/contributing/non-technical-documentation-guide.md
Notes:
The aim of these standards is to bridge the gap between technical and non-technical audiences. It's vital to stay adaptable and receptive to changes based on real-world application and feedback.
The text was updated successfully, but these errors were encountered: