Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop Standards for Non-Technical Documentation Tickets #8

Open
JangasCodingplace opened this issue Aug 20, 2023 · 0 comments
Open
Labels
documentation Improvements or additions to documentation

Comments

@JangasCodingplace
Copy link
Owner

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:

  • 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.

@JangasCodingplace JangasCodingplace added the documentation Improvements or additions to documentation label Aug 20, 2023
@JangasCodingplace JangasCodingplace added this to the Project Skeleton milestone Aug 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant