fpdcc / ccfp-asset-dashboard

CCFP Asset Dashboard
0 stars 1 forks source link

Write user documentation #274

Open smcalilly opened 9 months ago

smcalilly commented 9 months ago

We need to write up documentation about how to use the application. For inspiration, here's an example for the document search app: https://docs.google.com/document/d/19kgEViMIBVwCvDhUYfGJZ2490oe1ZcwGOE6b6i9FzM4/edit

We'll need to cover this non-comprehensive, wip list:

Write up what you can and I can fill in the rest. For the first draft don't stress on detailed writing — an outline with some screenshots is enough and we can flesh it out from there.

xmedr commented 9 months ago

@smcalilly Here's a first draft of the user docs. I've got some comments in there with some initial questions, but feel free to add more! Also lmk if this link doesn't work for whatever reason.

https://docs.google.com/document/d/1gH9BuO27YUDlDvM-sMNLqbN4SXrIdmrOpJzFJlgBcI8/edit

smcalilly commented 9 months ago

@xmedr i reviewed the draft. looks good! responded to your comments and made a couple of tiny suggested changes.

xmedr commented 9 months ago

cool ty! i've got those last few changes in and now the only piece missing is the deployment section