visola/go-http-cli

Documentation, documentation, documentation

Closed this issue · 1 comments

visola commented

Documentation for a tool project like this has the following goals:

  • Help users of the tool understand what the tool does and how
  • Help contributors understand the architecture of the code and how it works

The first should include things like:

  • how to download and install the tool
  • a list of all the features and how to access them
  • known erros and how to solve/workaround

The second should include:

  • basic components and how they interact with each other
  • how to build

The first set could live in the root README file and should include a link to the second set. The second set can live somewhere else, e.g.: ARCHITECTURE.md or something.