Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix 404 guide links #536

Merged
merged 4 commits into from
Apr 17, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions content/engineering/our-approach/architecture-reviews.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,9 +173,8 @@ We’ve now seen some of the implications of following a core philosophy through

This document is the distillation of an architecture discussion between Alan deLevie, Jacob Harris, Brian Hedberg, CM Lubinski, Atul Varma, and Jessie Young. Many thanks also to Kane Baccigalupi for early technical leadership on the project. [See more information about the Micropurchase project](https://micropurchase.18f.gov/), their GitHub [repository](https://github.com/18F/micropurchase), and thoughts around [limiting technical debt](https://github.com/18F/micropurchase/blob/8c536e3064fa6bcc9c1c4d6131b9db51a8e456cb/docs/technical_debt.md).
## Documenting key decisions
Some 18F projects have found success using [Architecture Decision Records](https://adr.github.io/) to capture key decisions and the context to which they were made, with the goal of allowing future project developers to know if a decision should be revisited or not. The decision records are typically stored in the repository alongside the code, using [this template](https://github.com/joelparkerhenderson/architecture-decision-record/blob/main/templates/decision-record-template-by-michael-nygard/index.md). For example:
Some 18F projects have found success using [Architecture Decision Records](https://adr.github.io/) to capture key decisions and the context to which they were made, with the goal of allowing future project developers to know if a decision should be revisited or not. The decision records are typically stored in the repository alongside the code, using [this template](https://github.com/joelparkerhenderson/architecture-decision-record/tree/main/locales/en/templates/decision-record-template-by-michael-nygard). For example:

- [18F/piipan](https://github.com/18F/piipan/tree/main/docs/adr)
- [HHS/Head-Start-TTADP](https://github.com/HHS/Head-Start-TTADP/tree/main/docs/adr)
- [HHS/TANF-app](https://github.com/HHS/TANF-app/tree/main/docs/Architecture%20Decision%20Record)
- [HHS/TANF-app](https://github.com/HHS/TANF-app/tree/main/docs/Technical-Documentation/Architecture-Decision-Record)
- [transcom/mymove](https://github.com/transcom/mymove/tree/master/docs/adr)
2 changes: 1 addition & 1 deletion content/methods/fundamentals/privacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ The government’s use of information about people is subject to a number of law

Conduct a Privacy Threshold Analysis in collaboration your agency’s privacy office whenever a design calls for the creation of a new data store (for example, a database).

Ensure all collections of personally identifiable information (PII) are accompanied by a Privacy Act Notice. See, for example, <a href="https://www.gsa.gov/portal/content/162010" class="usa-link">GSA’s Privacy Act Notice for Design Research</a>.
Ensure all collections of personally identifiable information (PII) are accompanied by a Privacy Act Notice. See, for example, <a href="[https://www.gsa.gov/portal/content/162010](https://www.gsa.gov/reference/gsa-privacy-program/privacy-act-statement-for-design-research?_gl=1*1l8yehn*_ga*OTQxMTY3NTUwLjE2OTAyOTc4MDQ.*_ga_HBYXWFP794*MTcxMzIxMzIzMS43NC4xLjE3MTMyMTM4NDQuMC4wLjA.)" class="usa-link">GSA’s Privacy Act Notice for Design Research</a>.
cantsin marked this conversation as resolved.
Show resolved Hide resolved
</section>
Loading