Slashdot Mirror

← Back to Stories (view on slashdot.org)

Manual Writing Tools?

Posted by ryuzaki0 on from the from-code-to-printed-man-pages dept.

Saulo Achkar writes "I've been recently assigned the task to rewrite the user's manual to a piece of relative complex software. Today, the existent manual used was developed with reStructuredText, a very nice piece of software; unfortunately, we're not able to create classes or templates for things like similar interfaces (that share the same functions), which means we need to write more code and that means more editing. XML formats aren't very friendly to code or edit in, either. What kind of techniques or tools are there to make writing manuals a bit friendlier and faster?"

2 of 139 comments (clear)

  1. Use another person by JohnWilliams · · Score: 0, Flamebait

    Given that you make both a spelling mistake and a grammatical error in the first 100 words or so of this post ("Writting tools" for a "relative complex" piece of software, I think the best tool you can use is another person, prefarably one who can write!

    --
    Professional Idiot
  2. How's Your Portuguese???? by Anonymous Coward · · Score: 0, Flamebait

    All you pompous twats that are quick to complain about his "poor writing skills" have failed to notice that the requestor is Brazilian! English is not his native tongue and the manuals that he plans to write are probably not English either.

    So, having harangued the man because of your own ignorance I must ask; How is your Portuguese? I'm willing to bet that your Portuguese is no where near as good as his English.

    Pesaroso, escrita == writing