TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Wiki as a final output of the documentation? From:Lech Rzedzicki <xchaotic -at- gmail -dot- com> To:Techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Sun, 15 Feb 2009 21:22:41 +0100
I am likely to be tasked with updating and revising some documentation which
is currently stored in a wiki in a chaotic form.
My task would be be to improve on the structre, usability etc and I know
exactly what to do to make it better.
However, I fear, that if I keep the final output in a wiki, it will quickly
deteriorate into it's old, chaotic and poor form.
Instead, I would like to write up a set of tasks in DITA, structure it
nicely and publish it on a web page.
Should the documentation need updating (which would likely be very soon), I
would want to trigger a defect in bug tracking/version control sstem that
they use for software being documented.
So my idea would be a more static HTML output from DITA rather than wiki,
but what this means is a lot more complicated process than what is in place
right now - i.e. just updating wiki.
What are your thoughts on this, which is likely to better in the long run?
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-