Beefy Boxes and Bandwidth Generously Provided by pair Networks
The stupid question is the question not asked
 
PerlMonks  

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??
I've used wiki, too, as a sort of on-going documentation system for development projects. It rocks! The lack of "ownership" of a node is a really good thing, since anyone can go & update the information on any of the nodes. And the "autolinking" it does is pretty nice- you don't have to worry about marking up words that you want to link, because if wiki sees that anything that you typed is a node, it automagically creates a link for you. Anyway, I've used a lot of different (usually crappy) documentation systems (html docs maintained through cvs... whiteboards in hallways...saved emails...). Most are either too much hassle to update or not scalable enough once you've got more than 3 people on a project. Wiki is a pretty cool solution to problems like that. My one problem with it (which might not be a problem with all versions) is that the more information you put in, the slooooooooooower searches get. -- cat

In reply to Re: Re: HTML documentation system - design and planning by cat2014
in thread HTML documentation system - design and planning by John M. Dlugosz

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 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? | Other CB clients
Other Users?
Others chanting in the Monastery: (2)
As of 2022-08-13 04:09 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?