Open jacobvjk opened 1 week ago
@cjyetman @jdhoffa I think in the end a cookbook that can be used as the main information hub for users to run P4S by themselves could have a structure like this. Feel free to comment any additions or aspects that you think do not belong here. I realize these are a lot of bullets, but in some cases multiple of those be may combined into a single page.
I think the structure looks great! I have some comments (might be things you are already thinking of, but good to have them explicit!). Also not necessarily saying each of these comments is strictly necessary, just brainstorming 😄
I'll start with General suggestions, and then more specific suggestions per section.
Modularity Consider making each section as modular as possible, so users can jump to the section they need without following the entire document in order.
Troubleshooting and FAQs Each top-level section (e.g., setup, running analysis, outputs) could end with a “Common Issues” or “FAQ” section to anticipate user difficulties.
Glossary A glossary of technical terms might be useful for less-experienced users.
Resources Provide links to any other external resources/ documentation/ the main PACTA website.
tree
cli to do this), so the user can clearly see where different files should be located.
We currently have some documentation that will be part of the cookbook
The final cookbook should be usable as a central document based on which the user can implement the entire analysis and/or find help in other resources.
The suggested structure is: