Government README
A simple practice can help give clarity to public sector projects and services, and how those impacted can engage with them.
All government artifacts should have some form of a README, including but not limited to:
Projects
Services
Agencies
Meetings
README 101
In developer terms, a README is a text-based file attached to a project repository.
It provides simple, clear information about a project, such as its purpose, function, how to contribute or submit issues, license and contact information. Technical information includes installation, configuration and operating instructions, list of bugs, troubleshooting help, changelog and technology used for the project.
They are usually in a .txt or .md file format (sorry, no README.pdf).
The README makes it easy for external developers to understand a technical project, learn how they can get involved.
The U.S. Web Design System, Vets.gov website and are examples of comprehensive, developer-centric READMEs.
Service driven README
While a README is typically for developer-based projects, the practice aligns with building effective government services. A README is helpful because it gives basic information without communications or public relations embellishments.
READMEs help:
Government service teams get clarity and alignment.
The general public understand what the service does and how it can engage with it.
They help a project or service give clarity about the service provided. They can be used as the foundational document that helps new onboarding team members, leadership and the general public understand what a service does, how to use it and how to get help when needed.