Forum Posts Feed
Using Outliner for Software Development Documentation?
< Next Topic | Back to topic list | Previous Topic >
Posted by Lothar Scholz
Apr 13, 2016 at 09:18 PM
If you are programming do you store ideas, designs decisions etc. in an outliner?
What and how do you use it?
Posted by Andy Brice
Apr 14, 2016 at 08:01 AM
No. Anything that is not embedded in the code is likely to get out of date and become misleading. So I try to put anything important in code comments and I try to write the code to be as clear as possible.
Posted by Paul Korm
Apr 17, 2016 at 11:23 AM
I read @Lothar’s question about “ideas”, “design decisions” as maybe something with a broader context than the internal notes that @Andy might insert in a specific module. (Andy’s approach is certainly the best practice for that.)
Quiver is an excellent Mac app for technical documentation. A Quiver document comprises “cells” (similar to the sheets concept in Ulysses). Cells types include cells for text, task lists with checkboxes (GFM), code (with proper syntax highlighting), LaTeX (MathJax), markdown, diagrams, and others. There’s a Quiver beta in progress for iOS, in addition to the existing Mac app.
Posted by MadaboutDana
Apr 17, 2016 at 05:11 PM
Funnily enough, I was about to mention Quiver.
Posted by Lothar Scholz
Apr 18, 2016 at 04:10 AM
Thanks, yes something like Quiver looks nice.
Wish only i could mark some points and ranges in source code and refer to them.