Beefy Boxes and Bandwidth Generously Provided by pair Networks
Problems? Is your data what you think it is?
 
PerlMonks  

Comment on

( #3333=superdoc: print w/ replies, xml ) Need Help??
"Even in a spoken presentation, repetition is just filler..." Not really in spoken word presentations is often used to ensure that the listeners have clearly understood the point or to emphasizes the point been made. And is a very useful tool to gauge the audiences take up of the new information. (Audience Contact - different than Audience participation but has similar goals). I think the point of the meme has been missed by the forum. I took this to mean that a brief over view of what information will be given to prepare the reader for the information or to let the reader know this is the section he needs to read (as he has a question about the software he need answering). the core of the material will be the second time the information will be talked or written about, but this will go into much more detail and fully expand on the solution to the given issue. Then the third time could be a 'this is the question that was asked in the outset and this was the answer that was discussed in the main body of the text'. this lets the reader quickly reference topics and answers to question, he may have. This could be at a later date after the first reading of the documentation. Sorry if this has bumped the topic to the top but i am finding it really helpful.

In reply to Re^4: Introduction to Technical Writing/Documentation by Anonymous Monk
in thread Introduction to Technical Writing/Documentation by ailie

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • Outside of code tags, you may need to use entities for some characters:
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.
  • Log In?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others imbibing at the Monastery: (6)
    As of 2014-12-25 11:36 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      Is guessing a good strategy for surviving in the IT business?





      Results (160 votes), past polls