Documenting for Thoth Tech
Documentation plays a vital role in the software development lifecycle at Thoth Tech. It ensures that our sustainable solutions are well-understood, accessible, and can be effectively handed over or referenced in the future. Proper documentation helps others understand the workings and rationale behind projects, facilitating continuity and knowledge sharing.
Documentation provides official information, prepared by the company, for both users and contributors. It is tailored to specific audiences and offers insights into the development lifecycle and final product.
All Thoth Tech documentation is stored in the Documentation Repository on our company GitHub. Documentation should be written in Markdown and cover various aspects such as research, meeting minutes, and software user guides.
Top Tips for Writing at Thoth Tech
Effective documentation is clear, concise, and easy to read. At Thoth Tech, we adhere to the principles of plain English, specifically Australian English, to ensure clarity and accessibility.
We aim for our writing to achieve the following goals:
- Empowerment: Providing knowledge to help our users and contributors make the most of our products.
- Respect: Creating inclusive and accepting content that values every individual.
- Education: Offering valuable information that supports learning and understanding.
- Guidance: Leading our audience thoughtfully towards their objectives.
- Honesty: Being transparent and focusing on our genuine strengths.
When writing documentation, consider these attributes:
- Clear: Ensure the content is easy to understand.
- Useful: Provide practical information that serves a purpose.
- Friendly: Use a tone that is welcoming and approachable.
- Appropriate: Tailor the content to the specific audience and context.
- Consistent: Maintain uniformity in terminology and style.
- Accessible: Ensure the documentation is easily accessible and understandable for all users.