# 18f/development-guide

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/18f-development-guide).**

_How this analysis was created: the description and tags below were written by an AI model that read this project's README and public documentation pages; stars, license and language come straight from the GitHub API. The model does not read the source code._

1,441 stars · 166 forks · HTML · NOASSERTION · archived

## Links

- GitHub: https://github.com/18F/development-guide
- Homepage: https://engineering.18f.gov
- awesome-repositories: https://awesome-repositories.com/repository/18f-development-guide.md

## Description

This project serves as a centralized repository and framework for documenting software engineering best practices, coding standards, and architectural patterns. It functions as a technical documentation system designed to maintain consistent quality and predictable outcomes across diverse engineering teams.

The framework utilizes a static site generation model that converts markdown-based content into searchable web assets. By leveraging git-based version control, it enables collaborative review workflows and tracks the history of documentation changes, ensuring that engineering standards remain a single source of truth.

The system includes automated tools to validate internal and external references, ensuring that all links within the documentation remain functional. This approach simplifies information sharing and provides a structured environment for maintaining technical knowledge that can be hosted on any standard web server.

## Tags

### Software Engineering & Architecture

- [Engineering Best Practices](https://awesome-repositories.com/f/software-engineering-architecture/coding-best-practices/engineering-best-practices.md) — Acts as a centralized repository of coding standards and architectural patterns for engineering teams. ([source](https://github.com/18f/development-guide#readme))

### Business & Productivity Software

- [Knowledge Repositories](https://awesome-repositories.com/f/business-productivity-software/knowledge-organizers/knowledge-repositories.md) — Serves as a centralized repository for storing engineering standards and architectural patterns.

### Content Management & Publishing

- [Version-Controlled Knowledge Bases](https://awesome-repositories.com/f/content-management-publishing/content-management-systems/content-architecture-modeling/document-architectures/version-controlled-knowledge-bases.md) — Leverages distributed version control workflows to track updates and manage contributions to technical knowledge bases.
- [Static Documentation Generators](https://awesome-repositories.com/f/content-management-publishing/content-management-systems/content-architecture-modeling/documentation-tooling/generation-publishing/static-documentation-generators.md) — Converts structured Markdown content into technical documentation websites using templates and navigation trees.
- [Markdown-Based Content Authoring](https://awesome-repositories.com/f/content-management-publishing/content-management-systems/content-authoring-tools/markdown-based-content-authoring/markdown-based-content-authoring.md) — Uses lightweight markup language to manage technical documentation and enable version-controlled collaborative editing.
- [Static Documentation Generation](https://awesome-repositories.com/f/content-management-publishing/static-site-document-generators/static-site-generators/static-documentation-generation.md) — Converts text-based source files into searchable technical documentation sites.
- [Static Site Generation](https://awesome-repositories.com/f/content-management-publishing/static-site-document-generators/static-site-generators/static-site-generation.md) — Generates a collection of static HTML pages from structured documentation files to ensure fast loading and high availability.
- [Technical Documentation Frameworks](https://awesome-repositories.com/f/content-management-publishing/technical-documentation-frameworks.md) — Provides a structured framework for managing software development processes and team engineering standards.

### DevOps & Infrastructure

- [Static Documentation Hosting](https://awesome-repositories.com/f/devops-infrastructure/static-documentation-hosting.md) — Distributes documentation as unchanging files for browser access without requiring a runtime server. ([source](https://github.com/18f/development-guide#readme))
- [Git-Based](https://awesome-repositories.com/f/devops-infrastructure/version-control-management/version-control/git-based.md) — Tracks documentation history and manages collaborative review workflows using distributed version control.

### Testing & Quality Assurance

- [Link Validations](https://awesome-repositories.com/f/testing-quality-assurance/link-validations.md) — Provides automated processes to identify and verify that external and internal links resolve to active pages.