Best practices when developing in Crystal codebases
Best practices when developing in Go codebases
Write an Architecture Decision Record (ADR) — lead with the decision, give neutral context, and state consequences both ways. Use when recording an architectural or technical decision, documenting why a choice was made, or capturing tradeoffs for future maintainers.
Write essays, blog posts, newsletters, and opinion pieces in a personal first-person voice — concrete cold open, argument by historical analogy, deliberate sentence rhythm, aphoristic kicker. Use when drafting or editing personal essays, blog posts, op-eds, newsletter issues, or any first-person long-form meant to persuade or reflect.
Write an RFC or design doc — summary-first, with goals/non-goals, real alternatives, drawbacks, and open questions. Use when proposing a technical change for review, writing a design doc, or documenting a system or feature proposal before building it.
Write clear technical documents — design docs, PR descriptions, proposals, postmortems — that lead with the decision and ground every claim in specifics. Use when drafting or editing workplace technical writing where a reader must act or later understand why. For the specific RFC and ADR formats, use writing-rfc and writing-adr.
Python development guidelines and best practices. Use when working with Python code.
Best practices when developing in Ruby codebases