User documentation

[joverbey]

Let's use this issue to coordinate work on user documentation.

Here's the plan:

• Jacob has made/is working on a first version of every page.
• When he's done, the primary author of the refactoring (@acalvert, @aggrand, or @joverbey) will review/edit the page. In particular:
  • Make sure the description of what the refactoring does is understandable to a "normal" C programmer.
  • Make sure the motivation (why would you use this?) is well explained.
  • For refactorings with options, make sure every option/argument is clearly explained.
  • Make sure the example is correct and compelling. If a screenshot needs to be updated, please ask Jacob to do it (so the "look" is consistent).
  • Make sure the list of Restrictions is correct and complete (nothing missing).
• @joverbey will review the finalized version of each page (or ask someone else to do it).

@galanite: Please let us know when each page is ready. Let's use this issue for discussion and to keep track of status.

[joverbey]

I will work on Tile and Intro ACC Loop whenever they're ready.

[galanite]

Beside pictures being retaken everything should be ready to go, IntroRoutine and IntroAtomics have the shell there but no information filled in.

Sent from my iPhone

On Jun 30, 2016, at 9:46 AM, Jeff Overbey notifications@github.com wrote:

Let's use this issue to coordinate work on user documentation.

Here's the plan:

Jacob has made/is working on a first version of every page. When he's done, the primary author of the refactoring (@acalvert, @aggrand, or @joverbey) will review/edit the page. In particular: Make sure the description of what the refactoring does is understandable to a "normal" C programmer. Make sure the motivation (why would you use this?) is well explained. For refactorings with options, make sure every option/argument is clearly explained. Make sure the example is correct and compelling. If a screenshot needs to be updated, please ask Jacob to do it (so the "look" is consistent). Make sure the list of Restrictions is correct and complete (nothing missing). @joverbey will review the finalized version of each page (or ask someone else to do it). @galanite: Please let us know when each page is ready. Let's use this issue for discussion and to keep track of status.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.