Ken Robertson (seadawg) wrote in lj_dev,
Ken Robertson
seadawg
lj_dev

Documentation

I know there are probably plenty of coders who will be contributing who probably know Perl a lot better than me, I thought I'd help out with documentation. It doesn't look like anyone has really taken any strides yet, so I'll take a quick stab at it.

I think the best way to go about documentation would be to do it like the PHP Manual. I've found their function references extremely helpful before, and the user comments make it a lot easier, since many post example code. Something like that for the LJ API would be pretty useful.

Basically, what should be done is classify every function into categories (user functions, scheme functions, maintenance, etc), then do a write up on how each function works (pseudo code style, with some english), the inputs/outputs, and link referrals to similar functions or functions it uses.

Any suggestions? I wouldn't mind spending some time creating a quick database/page for everything.
Subscribe
  • Post a new comment

    Error

    Anonymous comments are disabled in this journal

    default userpic

    Your reply will be screened

    Your IP address will be recorded 

  • 4 comments