2.12 Document and Share Project Outputs

Everything produced by designers, developers, writers, and those involved with a project should be in an open format, well maintained, and curated in a common format (so everyone is working from the same model).

Criteria

Deliverables Reusability: The deliverables output, including documentation, are used upstream of the project and produced in ways that will allow it to be reused in subsequent projects.
Deliverables Documentation: Design functionality and technical specifications are documented so that deliverables are comprehensible by the project team and transferable to the development team.
Deliverables Readability: Developers have access to code comments and other View Source affordances which can reduce the burden to access, understand, maintain, and utilize production-ready code as this will reduce redundancy and foster an open source culture.

Impact

Medium

Effort

High

Benefits

Environmental:
Deliverables that are used in common, easy-to-understand formats will take less computer time to learn and adapt to the environment. As such, less energy will be spent trying to manage a project with emissions savings as a consequence.
Economic:
Well-documented projects that can be implemented with ease are likely to have fewer ongoing costs due to a lower need for maintenance.
Conversion:
Using an open format, to which anyone can contribute, will have a lower barrier to entry as there will likely be no cost involved in participation. Therefore it will encourage more individuals to play an active role in your project’s future.

GRI

materials: Medium
energy: Medium
water: Medium
emissions: Medium

Example

System Design of a Website functional structure.

Resources

View the Guideline