📝 TOBIAS: Sprout README as Contributor-Facing Product Marketing
#2
Conversation
This file contains 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
- zinc-collective#709 - #1 This is an attempt at using a README as a form of product-design documentation. It follows the Pain-Dream-Fix recipe for marketing copy, with an emphasis on the code's *purpose*. By exposing the purpose of the code; new contributors (or contributors that have been away for a bit) have a way of grounding themselves in the product-thinking behind the project itself. That said, good README's have additional context beyond the purpose, such as: - A Data Model, which exposes a high-level view of the interactions between entities within the system we are building. - Setup instructions, such as guidance for how to populate an initial database or a reference to additional software to install. But for now we don't have either of those things; and I wanted to do some Product-based House Keeping, such as creating Fauxsonas and Use Cases before diving into Engineering.
It felt a little awkward and annoying; so I made it less awkward and annoying! But I think I'm done for now
zspencer
force-pushed
the
ToBIAS/write-readme
branch
from
fb03070
to
8cb5609
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Gizmosconvene#709TOBIAS: TOpical Basic Income Administration System #1This is an attempt at using a README as a form of product-design documentation.
It follows the Pain-Dream-Fix recipe for marketing copy, with an emphasis on the code's purpose. By exposing the purpose of the code; new contributors (or contributors that have been away for a bit) have a way of grounding themselves in the product-thinking behind the project itself.
That said, good README's have additional context beyond the purpose, such as:
But for now we don't have either of those things; and I wanted to do some Product-based House Keeping, such as creating Fauxsonas and Use Cases before diving into Engineering.