# C[omp]ute

Welcome to my blog, which was once a mailing list of the same name and is still generated by mail. Please reply via the "comment" links.

Always interested in offers/projects/new ideas. Eclectic experience in fields like: numerical computing; Python web; Java enterprise; functional languages; GPGPU; SQL databases; etc. Based in Santiago, Chile; telecommute worldwide. CV; email.

© 2006-2013 Andrew Cooke (site) / post authors (content).

## TiddlyWiki for System Design and Documentation

From: "andrew cooke" <andrew@...>

Date: Wed, 24 Jan 2007 10:52:16 -0300 (CLST)

I've never been a fan of Wikis in the past.  However, I am using
TiddlyWiki - http://www.tiddlywiki.com/ - in two different scenarios and
I'm very imprssed with the results.

First, I am using it to design the process needed for POJO Workflows -
http://www.acooke.org/cute/HowToMakeP0.html - where it has proved
invaluable in structuring my thoughts.  I use two kinds of entries, which
correspond roughly to sequence and class diagrams (processes and
components).  Keeping each entry small and cross-linking makes it easy to
detect inconsistencies in the design.  The advantages are similar to UML -
the trade-off is easier readability (text documentation) v less formal
specification.

TiddlyWiki helps here because it's quick and easy to use, requires no
configuration, and can easily be embedded as part of the final system
documantation.

Second, I am using it to create a summary of the system at work.  I am
using a similar approach - entries for both processes and services - but
with additional links describing architecture and technologies.  The idea
here is to provide a high-level description to improve understanding
across the team and the department.  We had a long, painful meeting where
we tried to do this with slides and presentations.  My hope is that the
Wiki will be complementary to that.  It also looks good enough to be used
as introductory semi-technical documentation (eg for collaborators).

Here the main advantages of TiddlyWiki (in addition to those above) are
that it looks very slick and can be emailed as a single page.

Andrew