Company Documentation

Company prides itself on our ability to produce sustainable solutions, this can be achieved through documentation. Documentation is an important element in the software development life cycle. It continues throughout the entire project. It is imperative to remember, others will take over your projects or want to learn more about how it works and why.

Documentation is offical information, provided by the company, for users and contributors. Documentation is written for specific audiences and provides knowledge on the development lifecycle and end product.

The Company documentation is stored in the documentation repositry., in the company GitHub. All documentation should be written in markdown and includes: research, meeting minutes, software user guides, and more.

Top tips for Company Tech writing

Effective writing is clear, easy to read, and concise. Company writing should follow the guidelines of plain English (Australian English).

Here at Company, we aim for all our writing to meet these goals:

• To Empower: We want our people to have the knowledge to make the most of our products.

• To Respect: We want our people to feel included and accepted for who they are.

• To Educate: We want to assist our people in their learning and provide them with the information they need.

• To Guide: We want to lead our people in a thoughtful manner towards their goals.

• To be Honest: We want to be truthful to our people and focus on our real strengths.

When documenting, we recommend you consider the following when writing your documentation:

• Clear
• Useful
• Friendly
• Appropriate
• Consistent
• Accessible

More information here:

• Writing Style Guide
• Documentation Writing Workshop