[tw5] Sample Documentation Guide

I was in the process of preparing a TiddlyWiki instance (a BASIC Anywhere Machine"User Guide"), and I figured might as well just start with a copy of the BASIC Anywhere Machine Programming Reference and strip away what I don’t want so that I am left with just the architectural things (organization, presentation, etc.) for documentation.

It didn’t take me long to realize that what I had was a proper TiddlyWiki starter file for any kind of documentation, including documentation about how to use the starter file.

If of interest to anybody for study/whatever, I’ll be slowly putting together the BASIC Anywhere Machine Documentation Starter (i.e. the “empty.html”) and the BASIC Anywhere Machine Documentation Guide (i.e. how to use the documentation starter and create documentation; nothing there yet).

1 Like

And I need two more TiddlyWiki instances (nothing in them yet) for BASIC Anywhere Machine documentation:

So a lot of things that to me are part and parcel of any software development project, from start to delivery and into deployment/operation/maintenance (I tend to see all things as projects):

  • A proper project portal, a one-stop place from which all things can be accessed
  • One or more blogs
  • One or more discussion forums
  • Documentation (Project, product usage guides for general usage and technical usage, technical documentation i.e. architecture/design of the product)
  • All of the above handling things like “what’s new” info, contact/communication, etc. etc.

fyi: related blog entry