Documentation Software

[JackBroughton]

Hi All,

I have recently taken on a huge someone legacy system to maintain and add features to.

The original programmer is a business man and had no programming experience and the code is a mess. To big of a mess for me to start documentation from scratch. Is there any software you can suggest for me to start building documentation for this program?

Regards

Jack

[SparkOut]

I don't know what you are expecting - I don't know of any software that you won't have to create documentation from scratch.
But try screensteps from http://www.bluemangolearning.com/ it is one of the nicest pieces of software I use.

[scrabbles]

Hi Jack,

Do you mean code documentation tools like doxygen/naturaldocs and the like that can generate "documentation" or more an editor that can be used for documenting systems like MS Word?

Code gen tools — I'm not sure if they can handle livecode without some wrangling.

Writing tools — There's a plethora of them, from the ubiquitous general word processors like MS Word/Pages, to lesser known but great editors like Scrivener/Ulysses/IA Writer, to specialised technical writing editors like Madcap Flare, Adobe Framemaker & Robohelp. Another alternative is to just write a bunch of markdown files in a text editor like emacs/sublime text/vim and convert them using pandoc (Ulysses/IA Writer are markdown editors too), or you can go the static html way or wiki route. I use a wiki (part of redmine) + occasional reStructuredText (used a lot in python software) and MS Word most often at work. I mostly use Scrivener for collecting thoughts and drafting pieces.

I haven't used it, but screensteps is often recommended, as per SparkOut's comment.

- Mark

[FourthWorld]

Is your interest in authoring documentation as specs, or learning about the structure/flow of the code base?

[golive]

I also looked for documentation tools. I found this useful:

http://forums.livecode.com/viewtopic.ph ... 30#p112416


Look for "Raspberry Pi stacks collection #44 = nuzzler7b.livecode"

[bn]

there are 2 "Script Reporter" in "Sample Stacks", one by Stewart Lynch and a modification of that one by David Glass.

Unfortunately both don't work very well with current LC.

I modified them and posted a version here:

http://forums.livecode.com/viewtopic.ph ... 56#p125246

Kind regards
Bernd

[golive]

there are 2 "Script Reporter" in "Sample Stacks", one by Stewart Lynch and a modification of that one by David Glass.

Unfortunately both don't work very well with current LC.

I modified them and posted a version here:

http://forums.livecode.com/viewtopic.ph ... 56#p125246

Kind regards
Bernd

Hi Bernd

Thanks, looks good.

However printing gives a weird display.

I get the same messy overlap whether I print to paper on an HP printer, or print to a PDF file.


EDIT: I changed the print font using the Preferences cog and it works fine!

Very useful to have this routine, thanks for bringing it up to date.