Editing User vs Developer Documentation
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 3: | Line 3: | ||
'''User Documentation''' | '''User Documentation''' | ||
− | + | # Meant for users who are unlikely to ever look at the source code | |
− | + | # 99% of them are going to be using GRC to create flowgraphs | |
− | + | # Split up into two parts: the one-wiki-page-per-block and the usage manual (both will live in the Wiki) | |
− | + | # Each page will be about 1 block, and explain how to use that block and what each parameter means. There should be an example flowgraph. | |
− | + | # 99% of users don't care about a block's "make signature" or any of the under-the-hood functions | |
− | + | # The User Documentation is what would show up in GRC in the documentation tab, i.e. something much more user friendly than what currently shows up | |
+ | |||
'''Developer Documentation''' | '''Developer Documentation''' | ||
− | + | # In this context, developers are those who are modifying GR source code, or just software-dev-oriented folks who take the time to read through code | |
− | + | # If they are reading through a block's code, they probably know how the block works at a high level, but are interested in programmatic details | |
− | + | # Mostly consists of documentation is that in-line with the code | |
− | + | # Can be viewed in the Doxygen manual or just directly while viewing code | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− |