seed icon indicating copy to clipboard operation
seed copied to clipboard

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

Open spy4x opened this issue 2 years ago • 0 comments

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 avatar Jul 10 '21 15:07 spy4x