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.

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

docs(README.md): improve project description for readability #47

Open
spy4x opened this issue Jul 10, 2021 · 0 comments
Open

docs(README.md): improve project description for readability #47

spy4x opened this issue Jul 10, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@spy4x
Copy link
Owner

spy4x commented Jul 10, 2021

Rephrase text using Amazon "backwards" approach:

  1. Heading - Name the product in a way the reader (i.e. your target customers) will understand.
  2. Sub-Heading - Describe who the market for the product is and what benefit they get. One sentence only underneath the title.
  3. Summary - Give a summary of the product and the benefit. Assume the reader will not read anything else so make this paragraph good.
  4. Problem - Describe the problem your product solves.
  5. Solution - Describe how your product elegantly solves the problem.
  6. Quote from You - A quote from a spokesperson in your company.
  7. How to Get Started - Describe how easy it is to get started.
  8. Customer Quote - Provide a quote from a hypothetical customer that describes how they experienced the benefit.
  9. Closing and Call to Action - Wrap it up and give pointers where the reader should go next.
  10. If the press release is more than a page and a half, it is probably too long.
@spy4x spy4x added the documentation Improvements or additions to documentation label Jul 10, 2021
@spy4x spy4x added this to the v0.1 - Basic functionality milestone Jul 10, 2021
@spy4x spy4x self-assigned this Jul 10, 2021
@spy4x spy4x removed this from the v1.0 - Basic functionality milestone Aug 9, 2021
@spy4x spy4x changed the title Improve README docs(README.md): improve project description for readability Nov 25, 2022
@spy4x spy4x added this to the Future tasks milestone Nov 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

1 participant