Documentation & Guidelines (iDOC)
Writing clear, concise and appropriate forms of documentation, from code comments and JIRA tasks to wiki pages and guidelines. Providing effective ways to share their knowledge with others, including technical and non-technical documentation.
LVL 2 - Engineer I
Learning and praticing how to document their work.
- is learning to follow the fundamental Inviqa engineering guidelines.
- is encouraged to document own work but guidance needed to understand what is important.
LVL 3 - Engineer II
Able to create basic documentation for their work and project team.
- has a solid grasp of Inviqa's engineering guidelines.
- does a decent job of documenting their code and technical features where necessary.
- writes non-technical documentation, for example a user guide for a custom feature.
- provides context for reviewers on pull requests including description of work, screenshots ("visual PRs"), and external links as relevant.
- understands the purpose of ADRs, reading their project's ADRs and applying the knowledge to their work.
LVL 4 - Senior I
Produces readable, high-quality documentation at the appropriate level of detail for their audience in all areas of project work.
- contributes to engineering guidelines, either directly or through group discussions and encourages others to use them.
- writes clear, concise and appropriate documentation to cover all aspects of their project work.
- contributes to ADRs either through direct changes or helping with reviews.
- contributes to PR templates, helping ensure the content is relevant and used by the team.
LVL 5 - Senior II, TTL
Leads others on documenting technical decisions at project level, especially through ADRs and guidelines.
- is a significant contributor to Inviqa's engineering guidelines and processes, encouraging others to contribute too.
- guides others on the appropriate level of documentation.
- guides their team to use ADRs through encouragement and review, and leads by example.
- introduces and defines PR templates, educating their team on how it should be used throughout a project lifetime and encouraging collaboration on template revisions.
LVL 6 - Principal, SEM
Leads others on documenting our technical decisions, especially at a higher departmental level, with a greater impact on the wider community.
- is a core contributor to Inviqa's engineering guidelines and processes, by collaborating with multiple teams to establish what's of consistent value to Inviqa.
- ensures that documentation quality is maintained to a high standard across projects.
- ensures that guidelines are followed by multiple project teams.
- helps determine artifacts of re-use from within project teams to share and help Inviqa become more economical in future.
- promotes the use of ADRs on projects, and identifies opportunities to share knowledge on these decisions between projects.
- promotes the use of PR templates on projects.