Skip to content

Outline motivation/"sales pitch" in README #22

@jnormile

Description

@jnormile

Hey, SEERS team! I know documentation is very much still a work in progress, but I wanted to leave a note about something to keep in mind as you continue to build this out.

In the documentation for the scripts directory, your team included a brief statement about the motivation or the "why" for the content that exists in the directory. I'd like to encourage you all to be sure to include something similar to this on your main page README as well! Make it clear what the use case for your tool is out of the gate, considering what kind of users would benefit from using your tool, or what the proposed utility of your tool is. (Think user stories!)

What you've put together so far is very exciting--just don't forget to communicate that excitement to potential future users looking at your repository!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions