2.12 Make deliverables understandable and reusable
Create well documented deliverables so that future users can find and make use of them without requiring assistance or expending unnecessary time and resources.
Criteria
- Deliverables Reusability: Machine-testable
Create deliverables, including documentation, in ways that facilitate later reuse.- 4 Ways to Make Your Code More Reusable
- 7 simple habits of the top 1% of engineers
- A Sustainable Design Handbook
- GR491 – 1-3008 – Reusability
- How to Write Clean, Reusable Code
- How to write exceptional documentation
- Society Centered Design
- System design
- System Design in Software Development
- System Design Roadmap for Beginners
- System Design: The complete course
- Deliverables Documentation: Machine-testable
Document functionality and technical specifications so that they can be understood by everyone that needs to use them.- Creating effective technical documentation
- GPF – General Policy Framework (PDF) – 1.10 – Strategy (Documented APIs)
- GR491 – 7-3050 – Documentation
- How to Write Technical Documentation That People Will Actually Read and Use
- United Nations SDGS – Goal 4 – Education
- Write the Docs
- Writing Better Documentation
- Deliverables Readability: Machine-testable
Developers have access to code comments and have the ability to view source to make it easier to access, understand, maintain, and use code.
Benefits
- Conversion
Using open and reusable formats lowers barriers to entry, as there will likely be no cost involved in participation. It can encourage users to play a more active role in the project. - Economic
Creating and maintaining good documentation will make implementation easier and reduce future ongoing costs associated with maintenance. - Environment
Using common and clear formats for deliverables will reduce the time users need to spend familiarizing themselves with and adapting to the environment. This reduces the energy spent managing a project and the associated emissions.
GRI
- Materials: Medium
- Energy: Medium
- Water: Medium
- Emissions: Medium