Beefy Boxes and Bandwidth Generously Provided by pair Networks
Do you know where your variables are?

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??
Hi all, this question may seem basic, and obvious, but I couldn't find anything useful on SuperSearch.

I'm involved in a web project and I'm writing stuff to glue it together. In the event of me being squashed by a bus tomorrow, I want my employer to be able to use what I've written, and fix/extend it with time.

At the moment there are no other Perl or web people in the team, the project is an out growth of the SAP team. With time there will be non-technical users as well, but barring an unfortunate incident with a bus, I don't expect the permenant Perl/Apache/Web team ever to grow beyond me.

What kind of documents are useful? I need to document the project so people can use it and extend/fix it, so I assume I need at least two kinds of docs: technical and user.

Every script I write is commented and had POD, obviously, but that's not much use to most people at the moment. At every change as I go along, I print out hard copy, and file it, generate HTML from POD, as well as archiving it.

I'm also building an intranet "how-to" users guide as I go along, with examples and user instructions. I'm not a technical writer, and as everyone knows it's easy to forget to mention something that you as the author knows..

So my questions:

What strategies have monks found helpful in their projects, both user and tech docs?

When you inherited projects, what helped you carry on?

Any books or web sites to suggest for small projects of this nature?

As ever, humble thanks in advance...

In reply to How to write documentation? by ajt

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?

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

How do I use this? | Other CB clients
Other Users?
Others exploiting the Monastery: (6)
As of 2021-12-02 10:56 GMT
Find Nodes?
    Voting Booth?
    R or B?

    Results (18 votes). Check out past polls.