All our interactions with the public (anyone outside the bureau, including other federal or state agencies, institutions, and consummers) should be easy to understand and use regardless of the communication channel (website, printed pamphlets, reports, our consumer response hotline, and email). Currently our email communications have not been given the same consideration as some of our other channels of communication.
This project aims to provide a technical framework, templates, and a content strategy for external communication via email.
Content guidelines will be hosted in the Design Manual.
Describe any dependencies that must be installed for this software to work. This includes programming languages, databases or other storage mechanisms, build tools, frameworks, and so forth. If specific versions of other software are required, or or known not to work, call that out.
Detailed instructions on how to install, configure, and get the project running. This should be frequently tested to ensure reliability. Alternatively, a link to another page is fine, but it's important that this works.
If the software is configurable, describe it in detail, either here or in other documentation to which you link.
Show users how to use the software. Be specific. Use appropriate formatting when showing code snippets.
If the software includes automated tests, detail how to run those tests.
Document any known significant shortcomings with the software.
Instruct users how to get help with this software; this might include links to an issue tracker, wiki, mailing list, etc.
Example
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
This section should detail why people should get involved and describe key areas you are currently focusing on; e.g., trying to get feedback on features, fixing certain bugs, building important pieces, etc.
General instructions on how to contribute should be stated with a link to CONTRIBUTING.