Slashdot Mirror


Single Sourcing: Building Modular Documentation

Scott Abel writes "Kurt Ament has hit the nail on the head! His latest effort, Single Sourcing: Building Modular Documentation is a valuable reference for those of us who seek to save time, effort, and money by implementing a productive method of creating information once and reusing it often." It's not a big book -- just 246 pages. Read on for Abel's brief review. Single Sourcing: Building Modular Documentation author Kurt Ament pages 246 publisher William Andrew Publishing rating 10 reviewer Scott Abel ISBN 0815514913 summary How to build modular documentation you can re-use in different formats for different audiences and purposes Ament covers the issues -- step by step -- that many others only discuss. He lays out a simple roadmap, complete with real world examples that have worked -- or not worked -- for his clients.

In Chapter 1 (About Single Sourcing), he carefully defines "single sourcing" and explains related concepts (reusable content, modular writing, and assembled documents) in ways that are easy to understand and free of techno-jargon. And, he does us all a big favor by addressing the negatives associated with using technology to assemble documents by explaining that it actually takes more creativity to write content that can fit into multiple media, for multiple audiences, than it does to continually rewrite information over and over again each time it is needed.

Chapter 2 (Building Documents) and Chapter 3 (Structuring Content) are of particular value to those seeking to understand the shift in thinking required to master single sourcing. Writers, programmers and managers will all benefit from these chapters. Each chapter is packed full of tips and examples you can begin using today!

Chapter 4 (Configuring Language) explains how to "configure" your writing to support and increase usability while Chapter 5 (Leveraging Technology) touches on issues including conditional text, conventions, localization, translation, variables and more. As are the previous chapters, Chapter 5 is written in clear, concise language and is not a chapter business types should skip. In fact, it's just the opposite. Managers and decision makers need to understand the concepts explained in this chapter because many of the benefits a single source strategy can deliver are made possible by combining good planning with the right technology. And, while this chapter is certainly not about selecting software tools, the author helps his readers understand some of the issues they will need to understand as they begin thinking about their strategy and the types of functionality they'll need to support with the tools they select.

What I like most about "Single Sourcing" is that Ament went straight for the meat of the issues. He doesn't belabor points or confuse the reader by jumping back and forth from subject to subject (as so many poorly written IT-related books do). Instead, he supplies us with a book you can read in an afternoon and use the information contained within the next day at work.

But, be forewarned. You're going to want your sticky notes and your highlighting markers nearby. Chances are you'll be using them a lot!

Other resources:

Scott Abel (abelsp@netdirect.net) is a content management strategist who assists his clients in planning and preparing for content management initiatives. Scott is a frequent presenter at industry and professional service seminars, an instructor at Indiana University Purdue University at Indianapolis Community Learning Network, and vice president of the Society for Technical Communication (STC), Hoosier Chapter. You can purchase Single Sourcing: Building Modular Documentation from bn.com, though new copies are currently out of stock. Slashdot welcomes readers' book reviews -- to see your own review here, read the book review guidelines, then visit the submission page.

130 comments

  1. Use a wiki by Anonymous Coward · · Score: 1, Funny

    That way you have documentation, not docucucucucucucucucucucucuumentation.

    1. Re:Use a wiki by Anonymous Coward · · Score: 0

      can you point me to one wiki that has useful, navigable, accessible, or up-to-date information?

    2. Re:Use a wiki by Anonymous Coward · · Score: 0

      http://www.haskell.org/hawiki/FrontPage There's one, as per your requests. There are others.

    3. Re:Use a wiki by Khalid · · Score: 1

      Wiki is indeed a very nice tool to create collaborative documentation. It's also very useful to organise your own notes, links, or what you have gathered on the Web. I use TWiki http://twiki.org since two years, it's one of the best wikis in my opinion, I put in it everything I need, my todo lists, my install notes, interesting articles, a very nice way to create you own knowledge base.

    4. Re:Use a wiki by slim · · Score: 1

      Wiki is indeed a very nice tool to create collaborative documentation.

      Maybe, if you restrict access.

      But I've seen way too many publicly modifiable Wiki pages collapse into a discussion about what Wiki is for/about.

  2. Use Eiffel by afidel · · Score: 1, Troll

    Because of design by contract the code is pretty much self documenting.

    --
    There are 4 boxes to use in the defense of liberty: soap, ballot, jury, ammo. Use in that order. Starting now.
    1. Re:Use Eiffel by BlueGecko · · Score: 3, Funny
      Because of design by contract the code is pretty much self documenting.
      Well, so's COBOL, but that's hardly a strong argument to use it.

      (Calm down, it's meant in gest. :)
    2. Re:Use Eiffel by JLyle · · Score: 1
      Because of design by contract the code is pretty much self documenting.
      I got the impression from the review that this book addresses the problem of assembling different forms of end-user documentation from a single source. While I agree that DBC is an excellent tool for documenting the code's internal interfaces and implementation, that's not going to be very useful to the non-programmers in your audience.
    3. Re:Use Eiffel by Anonymous Coward · · Score: 0

      I won't use anything French. Traitors.

    4. Re:Use Eiffel by smittyoneeach · · Score: 1

      ingest? No, not hungry.

      --
      Get thee glass eyes, and, like a scurvy politician, seem to see things thou dost not.--King Lear
    5. Re:Use Eiffel by Anonymous Coward · · Score: 0

      Troll ?????
      Some moderator is on some serious crack, hope they get caught in metamod.

    6. Re:Use Eiffel by joto · · Score: 3, Informative
      Use Eiffel

      Because of design by contract the code is pretty much self documenting.

      Yeah, right!

      Design by contract won't make your code any more self-documenting than design by committee.

      If you want self-documenting code, write something ridicoulusly simple. If you are doing something hard, you need explanation beside the code (unless you assume that everyone reading the code will be a domain expert, but in that case I wouldn't call it self-documenting).

      Eiffel isn't even designed to be self-documenting. It is designed to facilitate run-time (and in some very few cases: static) checking of program invariants, preconditions and postconditions. This will help for correctness, but not much for documentation. In many cases, the code will be easier to understand without them. (Not that I would recommend it, I do like DbC, but only as means to correctness, not as documentation).

      Sure, writing down assertions will in some cases help you in how to use an interface, or help you with other underlying assumptions in the code, making it easier to change something without breaking it. But it will never tell you anything about what the code is supposed to do, why it's supposed to do that, and why this way has been chosen to do it.

      Now, go re-read your Eiffel book, and come back evangelizing it when you understand it's purpose!

  3. Creativity? by chmod000 · · Score: 5, Interesting
    And, he does us all a big favor by addressing the negatives associated with using technology to assemble documents by explaining that it actually takes more creativity to write content that can fit into multiple media, for multiple audiences, than it does to continually rewrite information over and over again each time it is needed.


    This would seem to be more of a reason to avoid modular doco. Creativity is not, shall we say, plentiful? at the typical workplace. And often, it isn't wanted when it is available.

    --
    Aptal soru yoktur; sadece merakli aptallar vardir.
    1. Re:Creativity? by fm6 · · Score: 1
      This would seem to be more of a reason to avoid modular doco. Creativity is not, shall we say, plentiful? at the typical workplace. And often, it isn't wanted when it is available.
      Gawd, I wish I could say you were wrong. But you're not. Still, you have to ask why creativity is in such short supply. If you go out of your way to make a job (like document authoring and maintenance) pure drudge work, only dull stupid people will want to do it.
  4. make ambigeous by Anonymous Coward · · Score: 1, Interesting

    ./configure --enable-mod=ambigeous
    make
    make test
    make install

    1. Re:make ambigeous by Fizzl · · Score: 1


      http://dictionary.reference.c om/search?q=ambigeous
      </dictionary_police>
      *ducks*

  5. Will they read the finer manual? by SourceHammer · · Score: 5, Insightful

    It seems that no matter how much I spend creating documentation, the users of the system don't use it, don't know how to access it, won't use it.

    I say take your money and buy a book on user interface design. The problem is not how well written the docucumentation is; it is the fact that we NEED the documentation.

    --



    Open source development is my way of competing with the low-cost programmers in India...
    1. Re:Will they read the finer manual? by Mr2cents · · Score: 1

      I don't agree. Manuals have been around as long as machines/software. You can't expect someone to begin working with a complex program and discover all the features by him/herself. So while i whish it were true, not everything in life is plug and play. furthermore, manuals can also teach you clever ways to use the program and get things done.

      --
      "It's too bad that stupidity isn't painful." - Anton LaVey
    2. Re:Will they read the finer manual? by afidel · · Score: 1

      Documentation isn't for the silly users, its for the poor sap that has to maintain your code =)

      --
      There are 4 boxes to use in the defense of liberty: soap, ballot, jury, ammo. Use in that order. Starting now.
    3. Re:Will they read the finer manual? by Anonymous Coward · · Score: 0

      This is fine for programs that perform simple tasks, but for more complex programs the user interface simply can't contain all that a user needs to see. Scientific programs are often good examples.

    4. Re:Will they read the finer manual? by john82 · · Score: 2, Insightful

      Although what you say may be applicable to user interfaces, that is just a fraction of the documentation to consider. I can think of any number of proposal documents where we take a modular approach to sections: it's called boilerplate. When you have several proposals in the same line of work there's a lot of cut and paste from submission to another. On individual projects there are system design specs, operations & maintenance manuals and more. Your assertion does not apply in these instances.

    5. Re:Will they read the finer manual? by afidel · · Score: 1

      I know more about computer systems than 99.99999% of people yet I think I have consulted manuals proper about 5 times, mostly man pages. The rest is gleaned from web pages or just poking at the software.

      --
      There are 4 boxes to use in the defense of liberty: soap, ballot, jury, ammo. Use in that order. Starting now.
    6. Re:Will they read the finer manual? by Anonymous Coward · · Score: 0

      99.99999%. Suure. Nice.

    7. Re:Will they read the finer manual? by afidel · · Score: 1

      ok subtract one 9, one in a million. I'm a sysadmin with backgrounds in support, programming, and electronics, there aren't many people with more knowledge of computers. This is not bragging, simple fact, most people wouldn't want to know as much as I do. Yes there are a lot of people on slashdot that might but they are a very small % of the worlds population =)

      --
      There are 4 boxes to use in the defense of liberty: soap, ballot, jury, ammo. Use in that order. Starting now.
    8. Re:Will they read the finer manual? by Smidge204 · · Score: 2, Insightful

      I believe the quote goes... "Documentation is like sex. When it's good, it's really good. When it's not, it's better than nothing."

      It's all fine and good to make a great looking and intuitive UI whenever possible, but there's a lot of times when no matter how good a UI you make, the type of program (or device) it is will simply NEVER be intuitive enough to survive without some kind of explaination for what various widgets are for or what various errors/messages/etc mean.

      The problem is many people hear "documentation" and imagine 300+ pages of legalese descriptions. Good documentation can be as simple as a bullet list of functions with one-liner descriptions. If the UI can't be intuitive, at least you can make the documentation intuitive.
      =Smidge=

    9. Re:Will they read the finer manual? by Anonymous Coward · · Score: 0

      >> it is will simply NEVER be intuitive enough to survive without some kind of explaination

      Why not? You can either write it into the manual, or write it into the program in the first place.

    10. Re:Will they read the finer manual? by Anonymous Coward · · Score: 0

      Yawn. Yeah, you fuckin rule dude. Now get back to work.

    11. Re:Will they read the finer manual? by Tablizer · · Score: 1

      It seems that no matter how much I spend creating documentation, the users of the system don't use it...

      Put more porn in it

  6. Online reading habits different? by Anonymous Coward · · Score: 2, Insightful

    One thing I've noticed over the time i've spent surfing is that most online content has to get straight to the point with as little fuss as possible. If an article can't capture the interest of the reader within the title, or follow up within the first few sentences, people often quit reading and move on. I actually wonder how many people RTFA in slashdot.

    Very different from books, where the author is more able to exert without much fear of whiplash...

    1. Re:Online reading habits different? by r_barchetta · · Score: 1


      I actually wonder how many people RTFA in slashdot.

      You have to wonder?

      -r

      --
      Just because something is free does not mean you have to take it.
  7. use XML by stonebeat.org · · Score: 4, Interesting

    use XML. provides re-use of content. no big deal. and now there are collaborative XML editors, which allows authors to work on various sections of the same document.

    1. Re:use XML by Anonymous Coward · · Score: 1, Insightful

      >provides re-use of content

      oh yeah? can you explain how?

    2. Re:use XML by Ozan · · Score: 3, Informative

      And there is already a nice DTD for documentation called DocBook.

      There are also various XSL and DSSSL stylesheets to convert the docbook xml into html, xsl-fo, pdf, latex etc.

      Best thing with XML is, you can pack all of the documentation in one single place and create various documentations according to each audience (user, professional user, developer, etc) and language. There is no need to write duplicate informations, you only have to add certain attributes to the xml tags.

    3. Re:use XML by sisukapalli1 · · Score: 1

      Isn't it a little too cumbersome to "write" via XML? "Literate programming", where the documentation and the code are tied in, may not be a bad idea.

      Ofcourse, at the end, it is *what* is being said that is more important and *how* -- than *in what format*.

      The basic flaw these days among techies is that many don't write well. Changing the format is almost similar to chaging the typeface or the font.

      S

    4. Re:use XML by ken_mcneil · · Score: 1

      Seriously, is there anything that XML doesn't do? You can use XML to structure your documentation such that creating multiple presentations of it is automated. However, creating modular documentation that can be pieced together to create totally seperate documents is a whole other problem, and much more difficult.

    5. Re:use XML by Anonymous Coward · · Score: 0

      on similar note try AurigaDoc

      pretty neat and handy

    6. Re:use XML by Tsu+Dho+Nimh · · Score: 1
      "use XML. provides re-use of content. no big deal. and now there are collaborative XML editors, which allows authors to work on various sections of the same document."

      Have you ever produced content that was successfully "repurposed" without re-editing, just by using information embedded in the text at the time of creation? In other words, parsable something (SGML. XML, or whatever) that produced complete and coherent presentations with no human intervention after the initial content was produced?

      That has been the Holy Grail of documentation s long as I've been a tech writer, and I have yet to see it happen without requiring significantly more work getting it ready to repurpose than it would take to just sit down and do some editing and rewriting.

    7. Re:use XML by Tsu+Dho+Nimh · · Score: 1
      "AurigaDoc is a java-xml-xsl based documentation tool for writing xml documents and converting them to other open formats like HTML (single and multi page), DHTML, PDF, PostScript, Formatting Object(FO), RTF, Java Help and HTML Help(.chm)"

      Repurposing text != changing the file format. It means that what I write for a product specification can be reused in a user manual, a help system, or web page WITH NO FURTHER WORK editing or rewriting.

      That requires a level of granularity and consistency in tagging that is not currently cost effective. It requires DTDs, and means you MUST use them. At the moment, it's not cost-effective.

    8. Re:use XML by Anonymous Coward · · Score: 0

      and how does the XSLT rewrite the content (=the verbage) according to the targeted audience? People that talk about this stuff are people that have never done it. It looks good on paper, it falls appart when you try it. Enough fucking hype with XML.

    9. Re:use XML by Anonymous Coward · · Score: 0

      exactly ... read carefully, its a edit once, convert to any format without editing the content itself

  8. Cheesy by Webmonger · · Score: 5, Funny

    In a similar vein, Scott Abel has demonstrated how to use the same review for multiple audiences.

    Why not just submit a link, Scott? Sheesh.

    1. Re:Cheesy by imnoteddy · · Score: 1

      He also has the same review on amazon.com. I thought the other review at Amazon was better.

      --
      No electrons were harmed creating this post, though some may have been subjected to electrical and/or magnetic fields.
    2. Re:Cheesy by BenBoy · · Score: 1

      Why not submit a link? Oh, I dunno, maybe to avoid having his site buried under a steaming pile o' slashdotters :-)

  9. literate programming redux by Anonymous Coward · · Score: 0
    what am I missing?


    is this just literate programming warmed over?


    my main complaint with literate programming is that the source can quickly become unreadable (or, requires a different mindset to read it).

  10. Maven does some neat stuff with documentation.... by tcopeland · · Score: 3, Informative

    ....using Maven's xdocs, you can generate both HTML and PDF docs from the same XML source file.

    We use this on GForge and it works pretty well....

    Tom

  11. Genuine Review by Anonymous Coward · · Score: 0

    This was my genuine review in a year where I was the person to go to, to pull projects out of the fire...

    "Productivity, marginal. You get a lot done but you keep wasting time by writing documentation. So I've given you a marginal to reflect that."

    Teach me to work for a major games company.

  12. 246 pages is not big? by Junks+Jerzey · · Score: 3, Interesting

    I guess we've all gotten used to artificially inflated monster technical books, where it's expected that Learn Java 2 in 24 Hours needs to be 950 pages or it's crap.

    Here's a clue: Those big books are hugely padded by:

    1. Large margins so there can be a little note every few pages.
    2. Repeated program listings, also with huge margins.
    3. A hundred or more pages of fluffy introductory chapters ("What is a programming language?").
    4. Massive redundancy.

    Personally I'm waiting for the return of slim, readable books.

    1. Re:246 pages is not big? by Kingpin · · Score: 2, Insightful

      I've been told on multiple occasions that US authors get paid by weight rather than content. Anyone want to confirm or reject this?

      I'm sick and tired of having concentrate in order to locate "the point" within masses of text. K & Ritchies ANSI C book sets a fine standard for concise technical books. A fine example for Java is "Java Precisely", http://www.dina.dk/~sestoft/javaprecisely/

      --
      Unable to read configuration file '/bigassraid/htdig//conf/14229.conf'
      Geocrawler error message.
    2. Re:246 pages is not big? by Anonymous Coward · · Score: 0
      I've been told on multiple occasions that US authors get paid by weight rather than content. Anyone want to confirm or reject this?
      Yes, at least in my case. I was paid by the page, and that page count included screenshots.
    3. Re:246 pages is not big? by HisMother · · Score: 1
      > K & Ritchies ANSI C book sets a fine standard for concise technical books.

      I absolutely agree. Note, however, that my copy of K&R, 2nd edition, is a slim 272 pages -- longer than the book being discussed! 246 pages is a slim book indeed.

      --
      Cantankerous old coot since 1957.
    4. Re:246 pages is not big? by awol · · Score: 1

      K & Ritchies ANSI C book sets a fine standard for concise technical books.

      Beyond setting a fine example, K&R is a positive indictment of thick books:

      "C is not a big language, and it is not well served by a big book"

      Beautiful, so beautiful. sed "s/C/[many languages]/".

      --
      "The first thing to do when you find yourself in a hole is stop digging."
    5. Re:246 pages is not big? by WndrBr3d · · Score: 1

      Ahmen. The most resourceful book on the planet for me is LEARN SQL IN 10 MINUTES. It has quick refferences to JOIN statements and whatnot. It's a whopping 208 pages :-D

    6. Re:246 pages is not big? by Andrewkov · · Score: 1

      I'm going to create my own series of books, called "Learn xxxxx in 27.3 seconds", where xxxxx is some really difficult, technical subject. Of course each book will have to be at least 500 pages!

    7. Re:246 pages is not big? by Anonymous Coward · · Score: 0

      American books usually contains a lot of clay.
      See http://www4.ncsu.edu:8030/~hubbe/CLAY.htm for an
      explanation.

      The clay is cheaper than the pulp - so the paper is cheap.
      It also makes them brick-heavy. You get what you pay for.

    8. Re:246 pages is not big? by pmz · · Score: 1

      Those big books are hugely padded by: ...


      5. Voluminous reprints of public domain and easily accessible information.

      Linux Unleashed was the first (and last) "big" tech book I've bought. That book turned out to be a simple reprint of the man pages that led me to look for a book in the first place. I regretted buying that book so much that it really helped me set my priorities for later purchases.

    9. Re:246 pages is not big? by ergo98 · · Score: 1

      One of my prime criteria when buying technical tomes is ensuring that they didn't fill 2/3rd of the book full of "reference" type material (library function listings, etc). In the era of online help and resources, this is not only unnecessary, it's counter productive.

    10. Re:246 pages is not big? by Anonymous Coward · · Score: 0

      The words "confirm" and "reject" are not antonyms, so please do not use them as such.

      Thank you,

      AC Grammar Police

  13. That's what a REAL publishing package is all about by dkh2 · · Score: 1

    If you've ever used a program called InterLeaf you will understand that this is what publishing is all about.

    You create a content object and add it to your content library. Then, wherever you need that object, you point at it in the content library.

    For the HTTPd minded - it's the same idea as SSI.

    --
    My office has been taken over by iPod people.
  14. Wonderful review, only one question by katre · · Score: 1

    The only thing this left out: what the hell is Single Sourcing?

    1. Re:Wonderful review, only one question by Webmonger · · Score: 0

      Well, see, this review was written for the STC Single Source SIG newsletter. So, obviously, there was no need to define the term.

    2. Re:Wonderful review, only one question by HWheel · · Score: 3, Informative

      The Single-Source SIG (special interest group) of STC (Society for Technical Communication) defined single-sourcing as "using a single document source to generate multiple types of document outputs; workflows for creating multiple outputs from a document or database source."

      For more information:
      http://www.stcsig.org/ss/index.htm

    3. Re:Wonderful review, only one question by Anonymous Coward · · Score: 0

      a pipe dream.

      did that answer your question?

  15. Self evedent statement. by Drakin · · Score: 1

    The editors own and love this book. Just look at all the dupes posted. Same info again and again... (and in some cases, again and again...)

  16. Documentation professionals are creative by HWheel · · Score: 3, Insightful

    I think that a lot of this information is aimed at documentation professionals (technical writers, content strategists, knowledge management system workers, there are a lot of titles) who are very creative and love to work with these systems, rather than analyst/developers who view documentation as an evil waste of time.

    From personal experience, I know that it's not that difficult to mark text as "internal use only" so the developers can quickly find the names and values of parameters and "end user only" so that users who actually use the compiled system can see what the different options are.

    I think that the issue is less of "creativity" than it is of thinking through the issues and handling them consistently.

    1. Re:Documentation professionals are creative by Tsu+Dho+Nimh · · Score: 2, Interesting

      I somewhat agree ... i've worked on a few projects where the management had a wild idea that we could create content that could be used for web pages, user manuals, maintenance manuals, etc. with no further human intervention ... they had not thought about the limitations of the presentation medium. Realistically, the best you can do is create "chunks" that are easy to recycle because they are not contaminated with irrelevant information, have a consistent style, and do not depend on outside infomation.

    2. Re:Documentation professionals are creative by chmod000 · · Score: 1
      I am a developer, but not one of those that considers documentation evil. Not at all--it's just like another program in my experience. I'm all in favor of building "reusable" doco, insofar as this is possible. The trouble with it is, the machines have no choice but to run the proggies you write for them. But, as has been noted by many, "People are a problem". Remember "RTFM"?


      Given the sort of doco that usually crops up in what I laughingly think of as "real life", the prospect of having the most odious chunks of it modularized in order subsequently to pop up all over the landscape like seedy trailer parks is not something that spins the propeller on my beanie. Better to start with the advice of, say, Richard Mitchell and rid oneself of the plague of obfuscated bizspeak before allowing it to spawn. That done, go forth and conquer.

      --
      Aptal soru yoktur; sadece merakli aptallar vardir.
  17. 246 pages, only? by G3ckoG33k · · Score: 2, Funny

    Even if I have quite a few books on computer science, I still use www much more. It has far more than 246 pages and is near fully indexed through Google. And, cut'n'paste makes my life much more easier.

    Paper is near passé.

    And, new topics like this is often extensively referenced at popular sites like Slashdot; do yourself a favor and check it out!

  18. Kudos by jeepliberty · · Score: 3, Insightful
    Between small business environments and downsizing, engineers are now put in a position that requires them to document their software as well as providing operational and installation documentation.

    I remember providing input to a tech writer, then red-lining the first draft to the point that rewriting the entire document seemed necessary. While I would rather write PHP or scripts, there is no one who better understands code than its author.

    Today's on line documentation provides a variety of methods for an engineer to provide documentation. Such examples are:

    How to's and Mini How To's

    FAQ

    Web page with screen shots

    Forums and Blogs

    That being said, I am reminded of a conversation with Clyde, a retired avid sailor, who talked about stories in "SAIL" magazine. "First person stories written by sailors usually suck!" he said. "Give me an article written by a professional writer. They're easier to read."

    It's easier to write documentation than to try to tell someone what to write. ....Now if only I can break away from coding long enough to read this document on creating documentation.

    1. Re:Kudos by Saanvik · · Score: 1

      I don't think anyone would dispute that the person that develops code shouldn't test it. The same is true for documentation, for some of the same reasons.

      However, I agree, developers can, and should, contribute to helping users, especially through forums and blogs. Steve Muench does a great job on that at his website "Dive Into BC4J".

      BTW, the book being reviewed isn't really about writing documentation, it's about managing documentation projects, with some writing guidelines for creating modular docs. If you want a good book on writing high quality documentation for software, you should look at "How to Communicate Technical Information: A Handbook of Software and Hardware Documentation by Jonathan Price, Henry Korman"

  19. turning point? by voixderaison · · Score: 5, Interesting

    This review was stimulating, and filled me briefly with hope, then I crashed after pondering a bit. I'd like to think that we could look back on this someday as a turning point of some sort, perhaps the foundation of a new engineering discipline of documentation. Of course, lots of people thought (and probably still do) that SGML was the foundation and now we're building walls. And maybe it was, but SGML (and the derivatives HTML, XML, and future arbitrary useful DTD to come) suffer from some problems - external and cultural mostly. The technologies are somewhat complex, and there is a general lack of understanding about how to apply the technology to advantage.

    The core concept of arbitrary display and formatting of structured text, which appears to underly this new work, remains alien to most of the people making business decisions and authoring documents. When you combine a vacuum style lack of good tools to author documentation in the target technology with a flood of readily available "old paradigm" authoring tools for making stuff look pretty (word processors and desktop publishing stuff) you get the explosion in documents that was seen in the 90's. You also get the tremendous resource drain as these docs are updated and reformatted for subsequent generations of word processor formats that continue to mix content and presentation. We also see a direct parallel problem with the amazing fanatical market success of programming environments where logic and presentation are mixed (MS.asp, PHP, etc.) over object oriented tools. Far, far more dynamic web sites are built "the old fashioned way" despite the availability of decent, even "better" authoring tools that exist in the object oriented world.

    Unfortunately most organizations that produce and use documentation do so as an aside at best, or an afterthought at worst. Organizations typically don't value documentation highly enough to create job descriptions for skilled technical writers. Corporations with IT staffs of hundreds of people - managers, systems administrators, help desk workers, developers -- often don't have a single Technical Writer.

    Take the help desk as a primary example. Just about every big company produces volumes of documentation for use by the help desk workers. Sadly, much of that documentation is created after the fact, by desperately struggling front line help desk workers themselves, who randomly try to assemble facts and myth about problem resolution. The folk creating the systems are generally not given sufficient time to develop and maintain documentation, often barely enough resources to develop the system in the first place, before moving to the next task. It's rare for companies even to realize the blatant "in your face" opportunities to save money by investing in better documentation.

    If we can't get developers to understand this basic concept, how can we get front line help-desk workers who are writing documentation for themselves out of desperation and under the clock of "you still gotta answer twenty calls an hour and resolve 19 of the problems before hanging up"? Even better, how do we get a bureaucratic organization to invest in skilled technical writers?

    It seems to me that to get to this point we will need to create authoring tools that are so powerful and easy to use that the authors of documentation don't need to think about the separation of content and formatting -- it "just happens" in the background. Anybody who writes such a tool gets to spend the rest of their life retired on a beach, earning twenty percent and drinking rum from hollowed out pineapple shells with little paper umbrellas in them.

    --
    Things should be made as simple as possible, but not any simpler. -- Albert Einstein
    1. Re:turning point? by jolshefsky · · Score: 2, Interesting
      Just to spin what you've said--I think it's very sad that the organization of information is the afterthought in most documentation projects. The first question everyone seems to have is, "should command names be in Courier or Arial?" Come on ... if you're staring at the prospect of handling some quantity of information equivalent to (at a minimum) hundreds of pages of printed text, don't you think it should be your first priority to get a handle on how to organize that information?

      I'm mired deep in that territory now. I am desperately trying to attack the problem from the wrong side--I'm starting with our established desktop publishing package and trying to define meaningful styles that could be used in the future for content parsing.

      The battles I fight are so far removed from what's important, it makes me miserable--our document templates actually include a style called "Bold," for instance. Bold??? Why define the style at all if it's a built-in function? In programming C, it's like defining "TRUE" to 1 so you can write comparisons like (x==1)==TRUE instead of (x==1)==1. Whether you define a "style" or just click the little "B" icon, it's the same problem.

      The fact that we're using a desktop publishing package at all for data entry should be at issue--why not an editor to enter content in a hierarchy which will later be rendered by whatever appearance template we chooose? I wish I had a reasonable chance of ditching the desktop publishing package all together for something more pertinent.

      I think that like you, I'm also looking forward to the industry of documentation--or more likely--information organziation and presentation. I just hope I'm not dead first.

      --
      --- Jason Olshefsky

      Karma: Poser (mostly affected by adding this line long after everyone else did)

    2. Re:turning point? by Anonymous Coward · · Score: 0

      TRUE=(-1) dude :)

    3. Re:turning point? by xsumeman · · Score: 1

      You could ditch template wars by insisting everyone in your organisation uses an industry standard. Try DocBook, an SGML standard for authoring technical documenation. I've used this for a number of years, knowing the information I'm producing will be processable in years to come. It's scaleable to huge numbers of large documents, so with that covered, you can go back to arguing about which fonts to use for command names ;)

  20. Re:fp by MOD+PARENT+FAIL+IT! · · Score: 0

    That added a lot.

    YOU FAIL IT!

  21. Rational Unified Process by Burz · · Score: 1
    RUP is a giant, modularized HTML/applet documentation system. It is designed to be customized to projects, and can accept plug-ins.
    RUP Link

    Also, the cobination of SoDA, Rose and Requisite Pro offer a lot of options for manipulating requirements and code documentation.
    ReqPro Link

    (If this seems like an ad... I work work for IBM Rational.)

    1. Re:Rational Unified Process by Tsu+Dho+Nimh · · Score: 1
      " RUP is a giant, modularized HTML/applet documentation system"

      And how does that help the quality of the CONTENTS?

    2. Re:Rational Unified Process by Chundra · · Score: 1

      Out of curiosity, why is it that any time I've ever tried to find out what this Rational Unified Process is all about, it ALL sounds like some big advertisement geared towards clueless management folk? Is it really all that great? Can somebody explain it in hacker terms? That shite makes my eyes glaze over.

    3. Re:Rational Unified Process by Tsu+Dho+Nimh · · Score: 1
      In hacker terms ... it's a pain in the ass to use, but PHBs like the idea and the sales staff convince them that it will make the project flow better.

      It does code check in and out, but so do other tools.

      It did make it possible to make sure we had all the requirements tested and passed (but a simple spreadsheet or bug reporter could have done the same thing). Unfortunately its tendency to blow up and trash documents unless the editing was done in a certain not-quite-documented sequence makes the thought of using it as more than a simple repository for tidbits of information about a project frightening. And as a repository of information, a file directory is just as good.

  22. Holy grail: automatic documentation by HWheel · · Score: 1

    What you've just described ("authoring tools that are so powerful and easy to use that the authors of documentation don't need to think about the separation of content and formatting") has been the holy grail for development/documentation teams for a number of years now.

    But earlier, you called for an investment in skilled technical writers. The fact that you even remember when a tech writer was assigned to every project (mostly because the mainframe programmers had no time or skills for such nonsense) should be a hint that those days were in a golden past. Tech writers, graphics developers, trainers, and so are are fast disappearing from all but the largest companies. Because of the ease of use of many development/design tools, all of us are expected to be analysts, designers, developers, writers, trainers, and maintenance men. Tools, such as XML that allows single-sourcing of documentation, is another step toward the combining of roles and the disappearance of another antique role.

  23. Use (everything) by xsumeman · · Score: 1

    The whole challenge of single-sourcing isn't in which technologies to use, but the integration of these technologies, the process by which content is produced and the interaction between content (knowledge) producers.

    For example, at my last company we wrote software products. Document engineers would typically take one of the (almost) finished products and start writing documentation from scratch. Technical information that was already stored in programs, on wikis, in configuration files, etc.. was duplicated in the official documentation. The results were mixed- although the documentation engineers were very professional and diligent, all sorts of inaccuracies crept in.

    How do you produce documentation without any duplication? That's a real challenge. XML is part of the answer because you can automatically transform XML information into a publishable format. But no company has all their technical information in one place, in one format. Scripting languages and literate programming are also part of the solution. But the challenge is in getting the collaboration between different people from different departments to work.. Changing the organizational culture from the lazy habit of copy-and-pasting information to the stop-and-think habits required for single-sourcing.

    Such a zero copy-and-paste organization is really hard to achieve, well done to the author for addressing this issue.

  24. Full Disclosure Please by entropy_uc · · Score: 2, Interesting

    I would find these reviews a lot more useful if there was more disclosure of the reviewers biases.

    How do I know the author isn't benefiting from writing his glowing review here in some way? I'm not accusing the reviewer of any misbehavior here, but when the only negative of a book is that "But, be forewarned. You're going to want your sticky notes and your highlighting markers nearby" I have to question the bias of the reviewer.

    Sample review checklist
    1. Have you contributed to this book or been cited within the text?
    2. Do you have a personal or business relationship with the author(s) or publisher?
    3. Do you sell services related to the books topic?

    1. Re:Full Disclosure Please by abelsp · · Score: 1

      I am, admittedly, biased. Why? I believe in single sourcing, have participated in successful single sourcing initiatives and think the book is great. It's simple and straightforeward. What's not to like?

      I don't know the author personally, nor am I employed by the author, etc. I just like the fact that someone FINALLY has written a book on the topic -- and done it well.

  25. Excuses.... by Jace+of+Fuse! · · Score: 2, Funny

    "Honest officer, I was just eating a can of pringles and I thought, 'Hey! Maybe someone provides free internet service outside this large office building!'"

    --

    "Everything you know is wrong. (And stupid.)"

    Moderation Totals: Wrong=2, Stupid=3, Total=5.
  26. But of course! by Anonymous Coward · · Score: 0

    It's a games company; naturally they're going to be peeved if you go writing all this helpful documentation and ruining all the fun. By the way, that kind of thing is called "cheats", not "docs" in the gaming business.

  27. Yeah, who needs documentation? by fm6 · · Score: 2, Insightful
    I take it you write your own user docs. Have you considered the possibility that you're not very good at it? Do you know how explain complicated features in a simple manor? Do you have the patience to discuss nit-picky details that you know intuitively but about which your users are totally clueless? Do you know how to organize an immense body of facts so that the reader doesn't go crazy trying to find one small unimportant fact -- unimportant to you, but essential to the user?

    Too many engineers look at tech writers as clueless English majors, useful only for cleaning up spelling and grammar. Or arrogant, burned-out former programmers who think they know everything, and really know very little. True, there are a lot of tech writers like that, and their product is not worth reading -- assuming anybody can read it. But there are also serious, motivated tech writers who know a lot about communicating technical subjects.

    I like to think I'm one of those. I'm biased of course, but I have been told, more than once, that nobody understood how a product or technology really worked until I sorted a huge pile of random facts into a useful form. (This is especially nice to hear when it comes from the people who designed the system in the first place!) I'm probably not the best in my field, but I think I earn my pay. (Well, no pay right now, industry slump y'know. Oh well.)

    Of course, not all documentation really needs a tech writer. You sound like you mostly write little end-user apps. For those, I agree, a good GUI is more important than a good manual.

    But consider my own specialty, the API manual. How many of those have you seen that don't make you scream with frustration? Writing good API docs is hard. (Lotta fun though, at least for a compulsive nit-picker like me.)

    And writing isn't as hard as maintaining. My last job involved a development framework with more than 10,000 APIs. Which was maintained in RTF. (Please don't laugh, it's not funny.) And which had to be single sourced for four different product targets. (Windows and Linux, two different programming languages.) And, oh yeah, my boss thought that version control was a silly idea.

    Why was this documentation base such a mess? Because at this company, the "nobody reads the docs" mentality prevailed. Even the writing team was infected with it. And this self-fulfilling cynicism really hurt the product. The API has a reputation for being obscure and hard to use. Whereas it's really pretty elegant, and even easy to understand, if properly explained. In this case, bad documentation is doing a lot to consign a superior product to undeserved oblivion.

    I should end with that pithy comment, but I have to drag the discussion back ontopic. Because of the company's indifference to doc issues, they're only now converting the documents from RTF to markup, something they should have done 10 years ago. Alas, the project is headed up by an intelligent but technologically clueless individual who thinks a little XML transform experience makes him an expert on content management. (Sour grapes? I guess. Then again, I did recommend hiring the guy.) Last I heard, the project was months behind schedule, and was close to being in deathmarch mode.

    So I'm deeply interested reading Ament's book. Maybe it'll be useful on my next job. But even if it's well-written, I don't think I'll enjoy the read. Too many lost opportunities.

    1. Re:Yeah, who needs documentation? by SourceHammer · · Score: 1

      I do not write my own user docs. I assert that even well written documentation mostly gathers dust. Maybe the problem is that too many bad documents got out there and because of the user's expectations of more of the same, users have given up looking at them. More likely it is the same syndrome that keeps people from reading the instructions when assembling a tricycle on Christmas Eve.

      --



      Open source development is my way of competing with the low-cost programmers in India...
    2. Re:Yeah, who needs documentation? by fm6 · · Score: 1
      I assert that even well written documentation mostly gathers dust.
      Absolutely right. But also beside the point. Even users who ignore documentation refer to it when they can't figure stuff out for themselves. Or at least some of them do. And when a user gets desperate enough to actually RTFM, they really need well-written docs.

      A couple more points I just thought of. First, documentation does more than help users use. It also tells potential users what the product can do. When I consider buying software (or any technical product, even a stereo), the first thing I want to see is the manual, so I know if the product can do things I need it to do. Bad manual, no sale.

      Finally, suppose we stipulate that you're right, and that documentation is a mandatory but essentially useless part of the product. Then the documentation has to be maintained. Which is expensive. And all the more expensive if you try to ignore documentation production issues. Like single-sourcing.

    3. Re:Yeah, who needs documentation? by Anonymous Coward · · Score: 0

      Dude, most of the best programmers are English and Philosophy majors. CS's and EE's are the ones you got to look out for.

    4. Re:Yeah, who needs documentation? by Anonymous Coward · · Score: 0

      Ooops, I forgot Math and Music. Those are just as big. And it's no wonder as these subjects are the modern equivalents of what the Greeks called the Trivium or the studies suited to the citizenry as opposed to the slaves.
      Anybody with superior ability in any of these subjects can, and often does, pick up programming just for fun.

    5. Re:Yeah, who needs documentation? by SourceHammer · · Score: 1

      You want to see the manual for a stereo before you buy it? I would say that most stereos and most software is sold without the buyer previewing the manual.

      --



      Open source development is my way of competing with the low-cost programmers in India...
    6. Re:Yeah, who needs documentation? by fm6 · · Score: 1

      Perhaps. But I tend to buy stuff with obscure features, like timed off-air recording. Am I a geek or what?

  28. XML, yes, NBD, no by fm6 · · Score: 2, Insightful
    Yeah, XML is da bomb. I wouldn't use any other format to maintain a non-trival document base. Especially one where single-sourcing is important. But "no big deal"? Guess again.
    • There are no affordable off-the-shelf content managment for most technical documentation apps. Yes, there's a lot of content management software out there, but it's either specialized in some other area (mainly web applications, 'cause there's a lot of money to be made there) or it's a general-purpose CMS platform that takes a lot of work to adapt to a particular purpose.

      XML-specific databases are very intriquing. Many have impressive feature sets. But it's still a work in progress. There's nothing out there you can buy and use without spending a lot of time adapting it to your specific project. Even without license fees (usually pretty high) the up-front costs are huge. Try getting your boss to approve spending a lot of bucks on a product with no track record!

    • There are lots of XML editing products out there, but few of them are serious products. Some dweeb combines a Java editor component with an XML parsing engine, and behold! A collaborative documentation tool! Not that easy.

      A few solid products are beginning to appear, but they all have serious limitations. I'm really taken with XMetal, but it only runs on Windows. (Even if you're not an open source zealot, you have to be cautious about a product that won't run on the platform your engineers use. Anyway, XMetal now belongs to Corel, which is busy imploding.) XMLSpy is powerful and cross-platform, but its editign features are clunky. FrameMaker 7 is OK (assuming you don't totally hate FrameMaker's primitive GUI), but creating or modifying an XML application for it is a nightmare. And there's really nothing else.

    • Retraining writers to think in XML terms is a bitch.

    • XML production tools are still pretty immature. XSL-FO will probably stabilize soon, but I wouldn't rely on it yet.
    Eventually, XML will take over. But it's gonna be a long, painful transition.
  29. You stick to coding and let me handle the docs... by Silverhammer · · Score: 2, Insightful

    Blockquoth the poster:

    I remember providing input to a tech writer, then red-lining the first draft to the point that rewriting the entire document seemed necessary. While I would rather write PHP or scripts, there is no one who better understands code than its author.

    You're right -- but it takes a LOT more than that to produce clean, usable documentation. And yes, I speak from experience; I've been a technical communicator for more than eight years, and I've spent the last two years just cleaning up existing documentation written by programmers.

    The problem I've found is that programmers tend to write documentation the same way they write code: they see a project as an assemblage of individual features and widgets, and they put most of their effort towards ensuring each of those features works correctly. The fundamental concepts that tie the features together into an application are largely taken for granted.

    As such, the documentation these programmers produce is technically complete and accurate but almost completely nonsensical from a real-world user's point of view. There's no unified flow or top-level view. The user is basically expected to already know what they want to do, so that all they need to do is look up how to do it.

    That's why I don't trust these efforts to make documentation "modular." It's impossible to develop a coherent narrative in such a format, and you can't really educate the user without that narrative.

  30. More creativity does not mean more time & effo by Nino+the+Mind+Boggle · · Score: 1

    Actually, it's a reason to not go plunging willy-nilly into a modular doc project.

    Yes, it takes a bunch of creativity and up-front effort to pull it off. But the payoff comes when it's time to put out a new version of a large doc set, or if you have to publish in multiple formats. We have a system we developed in-house (using Framemaker as the foundation) that we can use to pump out printed manuals, PDFs, raw HTML, compiled HTML (.CHM), and Windows Help, all from one set of source files. We could do other formats (RTF or raw TXT, for example) with minimal effort.

    But if you're doing a one-off doc, you're probably better off to just crank it out.

    --
    ------ "Darn floor. Big bite." (Koko the gorilla's best attempt at explaining the experience of an earthquake.)
  31. DocBook, sorta by fm6 · · Score: 1

    DocBook is cool. I'm writing a book using it. But it's not the format for all technical content. If you're writing your basic mass-market computer book, or the web equivalent, DocBook probably has everything you need. (Though the markup for the official DocBook reference is forced to use generic tables to list element parameters -- there's no specialized element!) But I'd hate to use DocBook for a big API document base, especially one where single-sourcing is an issue. IBM's DITA framework is immature, but looks promising.

  32. Literate Programming by fm6 · · Score: 1
    Literate programming has its place. Encouraging programmers to describe and implement in one pass is definitely a good thing. It makes for products that are better thought out and easy to maintain.

    But embedding all your documentation in your source code is a very bad idea. That's the concept behind JavaDoc, and I have the bruises to show how badly this works in practice. Writers and programmers tripping over each other. Programmers that don't know how to write markup or even prose. Writers that have to branch the source code tree because the main tree is frozen. There's more, but I'm beginning the have post-traumatic flashes!

    The solution I'd love to see is a tool that merges the embeded-comment docs with the full user docs. This would not only eliminate the problems of JavaDoc, it would flag inconstencies that happen when programmers don't keep the writers up to date.

  33. mod parent as 'FUNNY' by Anonymous Coward · · Score: 0

    or Troll... really.

  34. Hey stalker! by fm6 · · Score: 1

    Always nice to hear from you!

  35. A Better Command Line User Interface. Good Idea. by jdgeorge · · Score: 1

    I say take your money and buy a book on user interface design. The problem is not how well written the docucumentation is; it is the fact that we NEED the documentation.

    Because if only the hundreds of commands for which I maintain man pages had a decent user interface, those silly documents could finally be abandoned.

    Then I could move on to more important tasks, like posting inane comments on Slashdot.

    Comments like this one.

  36. Single sourceing: Tech Writing's Newest Boondoggle by tres · · Score: 2, Interesting

    Sorry, I've seen first hand "single sourcing" hard at work. It's the biggest boondoggle since the "synergies" of the late nineties.

    Writing good documentation is hard work. It seems to me that the only people who benefit from "single sourcing" are the people who are writing these books and giving overpriced lectures to rooms full of unemployed tech writers.

    Ultimately it won't improve the clarity or usefulness of your documentation. It won't provide you with the ability to understand the subject or the audience any better.

    Don't get me wrong, if there were a magic-bullet that single source claims to be, I'd be all for it. It would be nice not to have to worry about document formatting. But personally, I think it's simply another way for organizations like STC (The Society for Technical Communication) to filch money from their members.

    --
    Notes From Under *nix: blas.phemo.us
  37. Re:You stick to coding and let me handle the docs. by Tsu+Dho+Nimh · · Score: 1
    Exactly what I have found. They are lost in the trees and can't see the forest.

    They know the product (code or hardware) so well that they forget some of the preliminaries, and the stuff they produce is not task oriented. A cookbook produced by a similar method would have the titles for all the recipes listed together, all the ingredients in another place, all the mixing instructions together, all the cooking instructions listed together. Actually cooking something would require that you consult several spots in the same manual and hope that the title for what you picked actually had something to do with what you wanted to eat.

  38. Re:That's what a REAL publishing package is all ab by Anonymous Coward · · Score: 0

    It's called "QuickSilver" now.

  39. RUP in hacker terms... by PinglePongle · · Score: 1

    RUP is a development process framework. It's sold as a bunch of documents/templates/intranet stuff, at a pretty eye-watering price. What's a development process framework ? It's a way of saying "when you start a software project, you usually need to go through a bunch of stages. For each of these stages, we have templates/guidelines/documents blah to help you build non-code artifacts (project plans, requirements documents, release notes, the whole kit & caboodle). Customize this to your organisation/project by choosing the stuff you need - out of the box, the process contains over 100 "artifacts", so you probably want to leave some out - and you will have all the tools you need other than an editor, compiler and caffeinated beverage vending machine to create world class software.
    If I were running a major software team for a large, sophisticated organisation with a lot of cash to spend, I'd definitely look for something like the RUP. It requires a significant investment of time, effort and money, but just deciding how you're going to build software is a cathartic process, and it flushes out all the views people hold explicitly, rather than finding out halfway through that Fred doesn't believe in source code control, and Sue only works from CRC cards.
    Check out "Applying UML and Patterns: An Introduction to Object-Oriented Analysis and Design and the Unified Process (2nd Edition)" for a concrete example of how the RUP is applied - it's a lot more useful than the brochure-ware "books" I've seen.

    --
    It's all very well in practice, but it will never work in theory.
  40. Re:Single sourceing: Tech Writing's Newest Boondog by D.+Bryce+G.+H. · · Score: 1
    It seems to me that the only people who benefit from "single sourcing" are the people who are writing these books and giving overpriced lectures to rooms full of unemployed tech writers.

    I benefit from single sourcing. No, it doesn't directly make my books more effective, but it does mean I spend a little less time replicating changes all over the place, so I have that much more time to spend on more direct improvements to the books.

    It's not a "magic bullet," and won't even help at all in certain situations. But if you've got a lot of similar books with slight variations, and output them to multiple formats, single sourceing will help keep you sane.

  41. Re:LaTeX by Anonymous Coward · · Score: 0

    How is this post flamebait?

    The guy could have been less sarcastic, but his point is germane.

    For program documentation, the GNU Texinfo format is very nice. It generates Latex (to which the converters he mentioned can be applied) and also HTML, info, and PDF from a single source.

    I don't know of a way to handle internationalization with it, other than to have multiple .texi files.

  42. Re:Single sourceing: Tech Writing's Newest Boondog by tres · · Score: 1

    The thing about "single sourcing" is that people have been doing it for years. It's just never had the high-prestige and high price tag that it has today.

    My beef is that there's minority groups in the overly influenced world of tech writing that have convinced many others that "single sourcing" is a recipe that you can pay to learn at a three-day lecture, then go out and write great documentation.

    In the majority of cases, what single sourcing turns out to be is a great waste of time and effort. In my experience, it's a pipe-dream for project managers who are otherwise too lazy to think through the ultimate aims of the documentation and how those aims are to be achieved.

    I'll very much agree with you, the ideas that go into the buzzword, "single sourcing" are very helpful in creating varying document sets based around a core set of materials. The problem is, most of the time, documentation doesn't fit this model, and managers can't really deal with the extremely intensive and time consuming work up front.

    --
    Notes From Under *nix: blas.phemo.us
  43. Re:Single sourceing: Tech Writing's Newest Boondog by Anonymous Coward · · Score: 0

    Andrew? Is that you?

  44. Actually.... by fm6 · · Score: 1
    ...the best programmers seem to be Poli Sci majors. I guess my age is showing. I date from an ancient time when having anything to do with computers separated you from the rest of humanity. Once upon a time, the English Major was the stereotype of the technically clueless. Any suggestions as to an alternative?

    You've reminded me of a conversation I had a very long time ago. I was going to a school that had no Computer Science or EE department. Programming was taught in various science departments (mostly Math and Statistics). I told somebody that taking Logic had helped a lot with my programming.

    "What department is that in? Math?"

    "No, Philosophy."

    "We have a Philosophy department?"

  45. Wikis are lousy for tech docs. by KevinDumpsCore · · Score: 1

    Wikis are a lousy way to maintain technical documentation!

    In order for technical documentation to be useful, it must be clear, complete, correct, and up-to-date. Wikis do nothing to insure these qualities. In fact, the best model for insuring them is a central maintainer (a person or a team). A central maintainer can also insure another quality missing from Wikis: consistency!

  46. Re:Single sourceing: Tech Writing's Newest Boondog by Tsu+Dho+Nimh · · Score: 1

    And what really suckjs is that it's not even a NEW boondoggle. I've been hearing about the promised land of single source documents for at least a decade. Anyone remember "Information Mapping" with its expensive seminars and rigid templates? Where are they now?

  47. POD by Paul+Doom · · Score: 1

    I am glad to see another emerging IT "area" in which all the tools and consultants can be replaced by a set of simple Perl scripts.
    (pod2man, pod2html, etc.)

    --
    "Life is life." --Laibach