Question

Photo of Ken Roach

0

How can I write/publish great (user) documentation like the Rock team does?

1

I love the Rock documentation.  It's superb.

How can I create the same types of pages for my own (site specific) documentation?  I seem to remember reading somewhere that the Rock team was using some special tools for managing documentation.

Has anyone else created their own site specific user guides?

  • Photo of Nick Airdo

    0

    The Rock documentation is managed via custom models and blocks that Jon and David wrote, and is roughly based on the HTMLBook spec (as mentioned in this wiki entry).  At the time they were created, it didn't seem to be something that should be included in the core.

    • Ken Roach

      Ken Roach

      Thanks for your reply, Nick, and thanks for the link. I need to produce site specific documentation that explains what data we capture and why, and how we want our users to engage with Rock. It would be nice to be able to present it in a consistent way. Obviously there are lots of alternative ways of presenting documentation. We would even find this useful for our own training material. Could it be added to the core? Or could be offered as a purchasable add-on?

      • Jon Edmiston

        Jon Edmiston

        We're open making these blocks available, but they would need some work and documentation before they were reusable. Time is pretty limited right now, perhaps after we get the core churches up and running we'll have the time to get these blocks ready for others.