Part of the problem is that the people working on the
documentation aren't the same people making the code
changes (for the most part). Then there's also the fact
that a lot of documentation is somewhat duplicated, and
it requires that a member of the documentation clan see
a change and remember which documentation it will affect,
and then change it all. So far as I know there is no
general outline of all documentation--something I'd
especially like to see written (but note that I've
been inactive for the last couple of months due to moving).
Therefore, the best thing to do when you note some
documentation which is out of date is to mention it to
the site documentation clan. If you find that you're
doing this a lot, you could request to join sdc.
-
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.
|
