Beefy Boxes and Bandwidth Generously Provided by pair Networks
Don't ask to ask, just ask
 
PerlMonks  

comment on

( [id://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":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others pondering the Monastery: (5)
As of 2024-03-28 20:49 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found