Standard for Public Code

Document your objectives

Requirements

  • The codebase MUST contain documentation on its objectives – like a mission and goal statement – that is understandable for designers and developers so that they can use or contribute to the codebase
  • The codebase SHOULD contain documentation on its objectives understandable by policy makers and management
  • The codebase MAY contain documentation on its objectives for the general public

Why this is important

  • Provide an easy way for people to decide whether this codebase is interesting for them now or in the future
  • Help scope your own development as well as clearly communicate to other stakeholders and contributors what the codebase is for

What this does not do

  • Guarantee that the codebase achieves the stated objective(s)
  • Guarantee contributions to your codebase
  • Prevent other codebases from attempting to achieve the same objectives

How to test

  • There is an entry for the codebase objectives, mission or goal in the codebase documentation

Policy makers: what you need to do

  • Add the policy objectives to the codebase documentation, for instance in the README

Management: what you need to do

  • Add the organizational and business objectives to the codebase documentation, for instance in the README

Developers and designers: what you need to do

  • Add the technology and design objectives to the codebase documentation, for instance in the README

Further reading