Oracle FAQ Your Portal to the Oracle Knowledge Grid
HOME | ASK QUESTION | ADD INFO | SEARCH | E-MAIL US
 

Home -> Community -> Mailing Lists -> Oracle-L -> OT : Writing Documentation

OT : Writing Documentation

From: Michael <oqij4ngfcrweuh001_at_sneakemail.com>
Date: Sat, 25 Aug 2001 19:38:59 -0700
Message-ID: <F001.00377AE8.20010825194520@fatcity.com>

Hi everybody,

        Sorry, I realise this is a bit off topic - but I need to ask a question of all those developers out there.

        At the moment, the company I work for has a Web Developer position vacant
(working with ASP/ColdFusion with a SQL 7 Database Server).

        SQL 7 isn't exaclty oracle, I know, but it's a step in the direction that I'd like to take (db development stuff). So please, don't flame me for that :)

        In order to ensure that the applicants aren't idiots we've been asked to do a simple test which basically involves taking an access database with four tables inside it, and creating a login and product view page. I've done this, so this isn't related to my question (which I'll eventually get to)

        Additional to us having to submit the code to these pages, we are required to submit documentation on how our pages work, and why we made it work that way. I am able to do this, sure, but I'm not entirely sure if my format will be correct. So, can anybody out there give me some tips on what this documentatoin should contain? There's only about a 100 lines between the two pages, so there isn't much to write about.

        Any information anybody can supply would be _greatly_ appreciated. I have to hand this thing in in the not-to-distant future, so if you could rush it too I'd like that even more :)

        Thanks for your time, and once again, sorry for posting off-topic, but this is the best place I could think to ask.

Cheers,
Michael.
v

-- 
Please see the official ORACLE-L FAQ: http://www.orafaq.com
-- 
Author: Michael
  INET: oqij4ngfcrweuh001_at_sneakemail.com

Fat City Network Services    -- (858) 538-5051  FAX: (858) 538-5051
San Diego, California        -- Public Internet access / Mailing Lists
--------------------------------------------------------------------
To REMOVE yourself from this mailing list, send an E-Mail message
to: ListGuru_at_fatcity.com (note EXACT spelling of 'ListGuru') and in
the message BODY, include a line containing: UNSUB ORACLE-L

(or the name of mailing list you want to be removed from). You may
also send the HELP command for other information (like subscribing).
Received on Sat Aug 25 2001 - 21:38:59 CDT

Original text of this message

HOME | ASK QUESTION | ADD INFO | SEARCH | E-MAIL US