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.

Sign up for GitHub

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

Jump to bottom

📝 TOBIAS: Sprout README as Contributor-Facing Product Marketing #2

Merged
merged 2 commits into from
Jan 15, 2024
Merged

📝 TOBIAS: Sprout README as Contributor-Facing Product Marketing #2

merged 2 commits into from
Jan 15, 2024

Commits on Jan 15, 2024

  1. 📝 TOBIAS: Sprout README as Contributor-Facing Product Marketing 

    - 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.
    @zspencer
    zspencer committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    cc7a284 View commit details
    Browse the repository at this point in the history

  2. Tidy up the fix. 

    It felt a little awkward and annoying; so I made it less awkward and
annoying!

But I think I'm done for now
    @zspencer
    zspencer committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    8cb5609 View commit details
    Browse the repository at this point in the history