Home

Welcome to the USAgov-2021 Documentation Wiki!

This is a work in progress.

Documentation Structure

This wiki is split into 4 main sections:

1. About USAgov
2. How-To Guides
3. Technical References
4. Explanations

About USAgov

General documentation about the USAgov project.

How-To Guides

Guides the reader through the steps required to solve a problem or accomplish a goal. Solves the "How do I..." problem.

Technical References

The technical description of the project and how to operate it. Code determined — describe key classes, functions, APIs, fields, attributes, methods, etc — and set out how to use them.

Explanations

Understanding-orientated documentation that help clarify and illuminate a particular topic, and provide a bigger picture/context to the project.

Using the Documentation

• Search For Documentation (wiki)

Contribute to Documentation

• How to Add to the Wiki (wiki)
• Basic Markdown Guide (external)
• Advanced Markdown Guide (external)
• Using the Command Line (wiki)