staqjs / staq Goto Github PK

https://producingoss.com/en/producingoss.html

• Tell the reader clearly how much technical expertise they're expected to have.

• Describe clearly and thoroughly how to set up the software, and somewhere near the beginning of the documentation, tell the user how to run some sort of diagnostic test or simple command to confirm that they've set things up correctly. Startup documentation is in some ways more important than actual usage documentation. The more effort someone has invested in installing and getting started with the software, the more persistent she'll be in figuring out advanced functionality that's not well-documented. When people abandon, they abandon early; therefore, it's the earliest stages, like installation, that need the most support.

• Give one tutorial-style example of how to do a common task. Obviously, many examples for many tasks would be even better, but if time is limited, pick one task and walk through it thoroughly. Once someone sees that the software can be used for one thing, they'll start to explore what else it can do on their own — and, if you're lucky, start filling in the documentation themselves. Which brings us to the next point...

• Label the areas where the documentation is known to be incomplete. By showing the readers that you are aware of its deficiencies, you align yourself with their point of view. Your empathy reassures them that they don't face a struggle to convince the project of what's important. These labels needn't represent promises to fill in the gaps by any particular date — it's equally legitimate to treat them as open requests for help.

• Move to the org

Right now the AuthProvider is rendered in withAuth. This means only the top level App component can be wrapped in withAuth, and the auth prop has to be passed down explicity. We want to change this to work more like FirebaseContext .

• Add config parameters for value section and pricing section
• Add documentation for server side

The readme should have a short guide on how to install and set up a basic app using staq

• Create client package under the new scope
• Create server package under the new scope

Figure out where we want to put documentation for the project