| Aware |
- Can recognise key terms and fundamental concepts related to creating software documentation, software metadata, user manuals, and managing version control systems.
- Can describe the general importance of documenting designs, decisions.
- Can use documentation to understand existing designs and decisions.
|
| Practitioner |
- Can produce documentation that explains software designs, records decisions, and logs the results of testing.
- Can use version control systems to manage different versions of software and data, ensuring that documentation is clear and up-to-date, including using open-source code repositories.
- Can apply code review principles and practices to ensure quality documentation.
- Can follow coding standard guidelines and implement them in documentation.
- Can explain the importance of version control in managing software changes and historical versions.
- Can use appropriate metadata for version control to ensure that software versions are easily findable and accessible when needed.
- Can develop manuals and guidance to support users in understanding and using the software effectively.
|
| Senior Practitioner |
- Can implement best practice workflows for efficient version control and documentation management.
- Can create comprehensive and detailed software documentation, including managing complex version control systems for software and data.
- Can ensure that documentation accurately reflects software designs, decision processes, and testing outcomes, while resolving issues related to version control and software metadata.
- Can develop user manuals and guidance that support users in effectively and efficiently using the software, ensuring clarity and usability.
|
| Expert |
- Can provide strategic guidance and leadership to ensure the quality of software documentation and version control practices
- Can oversee the continuous improvement of documentation practices, promoting optimal software and data management across the organisation or project.
|
