EHLO
After the questions about a ‘Documenting Software HOWTO’ I wrote some
text that is available at
http://members.lycos.nl/jupp/documenting/
I am pretty sure that it is far from being perfect so I am
surprised that I didn’t receive any flames so far. Maybe the
announcement was to far down the thread? Especially the part about
documenting interactive software needs to be extended. Could anybody
suggest a simple program that should be used as an example (should be
as simple as possible but should have help, pull-down menus, and
hotkeys).
Josef ‘Jupp’ Schugt
···
–
.---------------------. .------…—…-----…—…-----.
http://jupp.tux.nu/ | | jupp || @ || gmx || . || net |
---------------------' ------‘---'-----’---'-----’
EHLO
After the questions about a ‘Documenting Software HOWTO’ I wrote some
text that is available at
http://members.lycos.nl/jupp/documenting/
Hello Josef,
Perhaps put up a link to the source of the document - makes it much
easier to provide you with comments in the form of diffs.
I am pretty sure that it is far from being perfect so I am
surprised that I didn’t receive any flames so far. Maybe the
announcement was to far down the thread? Especially the part about
documenting interactive software needs to be extended. Could anybody
suggest a simple program that should be used as an example (should be
as simple as possible but should have help, pull-down menus, and
hotkeys).
Cheers!
–zak
···
On Fri, Mar 14, 2003 at 09:19:38AM +0900, Josef ‘Jupp’ Schugt wrote:
EHLO
http://members.lycos.nl/jupp/documenting/
Perhaps put up a link to the source of the document - makes it much
easier to provide you with comments in the form of diffs.
The GFDL states:
“Examples of suitable formats for Transparent copies include plain
ASCII without markup, Texinfo input format, LaTeX input format, SGML
or XML using a publicly available DTD, and standard-conforming simple
HTML designed for human modification.”
I did choose standard-conforming simple HTML designed for human
modification. Seemingly Tripod does automatically add some
javascript.
I am just done with the following:
Re-formattin the HTML source so that it does not no longer contain
lines than exceed 79 characters in order to make it more
diff-friendly.
Providing a plain ASCII version (with no lines exceeding 79
characters).
Have a tar.bz2, tar.gz and zip containing the HTML and plain ASCII
text version as well as the ChangeLog. The files are automagically
updated using a - guess what - Ruby script (and a Makefile).
Josef ‘Jupp’ Schugt
···
http://jupp.tux.nu/ | | jupp || @ || gmx || . || net |
---------------------' ------‘---'-----’---'-----’