Documentation should be good, accessible and user centric

krieselreihe / litr

Litr (Language Independent Task Runner) lets you configure and then run any tasks you want for any language.

MIT License

8 stars 0 forks source link

Documentation should be good, accessible and user centric #9

Open MartinHelmut opened 3 years ago

MartinHelmut commented 3 years ago

There needs to be a website that is fast, accessible and user centric to be as easy to consume as possible.

MartinHelmut commented 3 years ago

Documentation will be available on Github (Basic) and https://litr.dev (Extended).

MartinHelmut commented 3 years ago

To ensure not duplicating work on the documentation there should always only be one source, therefore here a clarification what comes into what place:

GitHub Wiki, Development documentation such as:

Script parsing
Command line parsing
Used software
etc.

Website, usage documentation such as:

Quick setup (installation, setup)
Detailed configuration
FAQ and common usage cases
etc.