Strengthen Standard Base Documentation from community talk#908
Open
rrrutledge wants to merge 2 commits into
Open
Strengthen Standard Base Documentation from community talk#908rrrutledge wants to merge 2 commits into
rrrutledge wants to merge 2 commits into
Conversation
Adds three structural improvements to the Standard Base Documentation pattern, informed by Fiji "FJ"'s talk "Docs that Invite Devs": - New ARCHITECTURE.md section as a contributor-facing system map, distinct from Document Architecture Decisions (ADRs). Addresses the contributor hesitation of not knowing what is safe to touch. - New "How to know your docs are working" check, listing the five questions a newcomer should be able to answer from a quick scan. - Sharper Getting Started guidance in the README template: copy-pasteable steps, expected outputs, and a troubleshooting subsection. Also adds the talk under Known Instances, labeled as a community talk to distinguish it from the existing organizational adoptions. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
rrrutledge
requested review from
NewMexicoKid,
cewilliams,
lenucksi,
robtuley,
spier and
yuhattor
as code owners
Replace placeholder "Community talk" entry with the speaker's full name (Feyijimi "FJ" Erinle) and organization (Agentic Systems), matching the format of the existing organizational Known Instances. Speaker affiliation was obtained from the YouTube video description.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three structural improvements to the Standard Base Documentation pattern, plus a new Known Instance citation. Informed by Fiji "FJ"'s community talk Docs that Invite Devs (YouTube), which articulates why InnerSource docs frequently fail to convert readers into contributors.
Changes
ARCHITECTURE.mdsection in the Solution as a contributor-facing system map. Distinct fromDocument Architecture Decisions(ADRs): ADRs capture decisions over time, whereasARCHITECTURE.mdis a current-state map that lets contributors tell which parts of the system are safe to touch.README-template.md: copy-pasteable steps, expected outputs per step, and a troubleshooting subsection. Replaces the previous one-line description.Why now
The talk surfaces real gaps the existing pattern doesn't yet cover — particularly contributor-facing architectural orientation and an explicit usability check. Edits were kept surgical so they extend rather than reframe the pattern.
Test plan
base-documentation.mdfor prose flow and cross-link correctness (the newARCHITECTURE.mdsection links toDocument Architecture Decisions).🤖 Generated with Claude Code