Feb 21, 2008
Day 12: Documentation
Your team can use a wiki to collaboratively write, edit, and assemble documentation. If you publish it electronically, consider letting your audience contribute to the wiki and help build the documentation:
Your team can use a wiki to collaboratively write, edit, and assemble documentation. If you publish it electronically, consider letting your audience contribute to the wiki and help build the documentation:
An easy to use web app that helps your organization to capture, share and exploit its knowledge.
Future Changes is Stewart Mader. He wrote the book on wiki adoption, and he has led or advised enterprise-wide wiki deployments in Fortune 500 companies, universities, nonprofits, small and medium size companies.
Advisory Services include: adoption strategy and timeframe, vendor/product analysis, content structure and templates, roles and permissions, data migration, and workshops. Linda Ziffrin of Valley View Ventures handles bookings. Contact to discuss your needs.
![]() |
Wikipatterns A practical guide to improving productivity and collaboration in your organization. Buy the book |
![]() |
Using Wiki in Education 10 case studies from education show how to collaboratively build curriculum, guide students' teamwork, and manage research projects. Buy the book |
![]() |
Your Wiki Isn’t Wikipedia (PDF download) How to use a wiki for technical communication and project management. Published in the January, 2009 issue of Intercom, the magazine of the Society for Technical Communication. |
![]() |
5 Effective Wiki Uses (PDF download) Five ways your business can benefit from using a wiki. Published in the August, 2008 issue of Website Magazine. |
Scalability, security and just enough structure put social software to work.
Rebecca says:
Mar 3rd, 2008
Hi,
I am in the investigative stages of creating user documentation using a wiki. I currently have a multi-chapter FrameMaker document that I import into a HAT to create context sensitive help. How would I create a manual from multiple wiki pages?
Stewart Mader says:
Mar 3rd, 2008
Hi Rebecca,
I’m not sure what you’re referring to with the acronym HAT – can you give me more details there?
Thanks,
Stewart
Janet Swisher says:
Mar 11th, 2008
Hi Stewart,
HAT is Help Authoring Tool, which is a specialized program for creating online help for applications. Some of the top tools in this category are Adobe RoboHelp, MadCap Flare, and WebWorks ePublisher.
It seems likely that most wiki engines can export the content of the documentation wiki pages as HTML files, which could be imported by most HATs.
The tricky question is how to get the wiki-based Table of Contents into a format that a HAT would recognize as a TOC. For example, to produce Microsoft HTML Help (a.k.a. .chm, the standard help format on Windows), the TOC has to be in a specific structure of HTML 2.0 “li” and “object” tags. If the wiki doesn’t export in a format that can be easily translated into this format, you’re stuck recreating your TOC in the HAT.
I’m interested in any examples you can share of actual projects that have generated print or online documentation from a wiki. Even if you can’t share names of companies or their products that are documented this way, it would be helpful to know what wiki engine and other tools they use.