[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Computerbank] Documentation processes and documents at Computerbanks / Computer Angels
Hi All,
I am a newcomer, and furthermore missed the documentation meeting, but I would have been interested to have been there.
The list below gives a very brief idea of what exists, but access to the intranet to look at the documents themselves is really required to understand it.
Recently I was working on the inter/intranet at the State Library of Queensland. The policy was to use the 'metadata' field of the header of the HTML to give a description of the documents, last update, who by etc etc.
On many pages this metadata was more than the content of the page (they're librarians, remember). I don't think CB needs to go that far .. but .. it is a good idea. Then a web-crawler can compile weekly/monthly reports of what exists and summarise and email to relevent personnel.
http://au.dublincore.org/
http://au.dublincore.org/resources/faq/
Dublin Core is the metadata standard (?) used there. I would guess there are many others. Dublin Core is reasonably widely deployed.
Basically the metadata field on HTML lets you make up your own descriptive tags, which do not appear on the actual page in the browser, but can be accessed through some browsers, or other tools like the web crawler above, and are visible to anyone who edits the page.
It may be a good idea to adopt an external standard such as Dublin Core rather than develop internal metadata standards, and certainly wouldn't hurt. It is up to CB to decide to what and how much metadata goes on each page.
The good thing is even for web pages where it is not desireable to put a lot of irrelevent text, eg for aesthetic reasons, it provides a place for this stuff to go. Also if you have a policy of using particular metadata then it can be used to get the author to stop for a moment and think about how their document fits into the structure of the web, it's purpose, expected life cycle etc.
Also, a link checker is a good idea. This is another web-crawler which tests cross-linking integrity of documents to each other and to the net.
Simeon
----- Original Message -----
From: Con Validas <cvalidas@yahoo.com.au>
Date: Thu, 7 Nov 2002 12:28:22 +1100 (EST)
To: cbdoc-train@lists.sourceforge.net
Subject: Re: [Computerbank] Documentation processes and documents at Computerbanks / Computer Angels
> --- Kylie Davies <mailkylie@optushome.com.au> wrote:
> > Thats a start...tomorrow I will post a list of
> > documents used internally at
> > CAI-Vic and Con will post the list of documents that
> > are used on the CAI-Vic
> > Intranet.
>
> Hello all,
>
> These are the files that are currently on the
> Computerbank Victoria Intranet.
>
> INTRANET FILES (101 files, 07/11/2002)
>
> index.html
>
> IMAGES
> cb_logo.jpg
> debian.jpg
> debian_logo.jpg
> gnu-head-sm.jpg
> poweredbylinux.gif
> tuxsit.gif
> tuxsitsm.gif
> tuxwhitebig.jpg
> valid-html401.gif
> valid-html401.png
> valid-xhtml10.png
>
> STYLESHEETS
> style.css
> tutorial_style.css
>
> CONTACTS
> committee_members.html
> contacts_index.html
> staff_members.html
>
> DISK IMAGES
> boot_disk_images.html
> disk_images_index.html
> drivers-1.bin
> rescue.img
> root.img
>
> DOCBOOK
> docbook_index.html
>
> HARDWARE DOCUMENTS
> compaq_bios.html
> compaq_disk1.img
> compaq_disk2.img
> compaq_disk3.img
> guide_to_compaq_bios.html
> guide_to_ibm330_bios.html
> hardware_checks.html
> hd_index.html
> kill_disk.html
> kill_disk.img
>
>
>
> HISTORY
> cb_press_web.html
> history_index.html
> nostalgia.html
>
> INFORMATION
> cb_info_apps.html
> information_index.html
>
> LATEST NEWS
> latest_news_index.html
>
> OCC. HEALTH AND SAFETY
> cb_guidelines.html
> manual_handling.html
> ohs_index.html
> ohs_monitor_procedure.html
>
> POLICY
> confidentiality_policy.html
> draft_charter.html
> hs_policy.html
> policy_index.html
> reimbursement_policy.html
> sexual_harassment_policy.html
> volunteer_policy.html
>
> PROCEDURES
> hardware_procedures.html
> procedures_index.html
> process_for_assessment.html
> recipient_disclaimer.html
> software_procedures.html
> support_procedures.html
>
>
> SOFTWARE DOCUMENTS
> cb_linux_install.html
> cbv_soffice.html
> cups_howto.html
> debian_security.html
> ess_howto.html
> flash_linux.html
> installing_debian.html
> kde3.html
> kppp_howto.html
> magicfilterconfig_howto.html
> officeconfigcheat.html
> open_office_install.html
> ppp_config_howto.html
> sd_index.html
> soffice_install_cheatsheet.html
> soffice_troubleshooting.html
> system_checklist.html
> useradmin.html
> xserver_troubleshooting.html
>
> TRAINING DOCUMENTS
> abiword_hints.html
> email_help.html
> fsck_frozen.html
> gimpdoc_howto.html
> internet_start.html
> internetsetup.html
> kdelogonandoff.html
> netscapelockfiles.html
> printer_info.html
> telstra_connection.html
> terminal.html
> trainer_checklist.html
> training_index.html
>
> TUTORIALS
> cbprac_exercise1.rtf
> cbprac_spreadsheet_exercise1.rtf
> cbprac_spreadsheet_exercise2.rtf
> command_line3.html
> command_line_basics.html
> html_workshop.html
> office_internet_studyguide.html
> tutorials_index.html
>
> VOLUNTEERS
> volguide.html
> volunteers_index.html
>
> WORK FOR THE DOLE
> wfd_computerbank.html
> wfd_index.html
>
> Cheers,
>
> Con.
>
> >
> > Can I have other Computerbanks / Computer Angels or
> > whoever right freed
> > documentation - let us know what you have and what
> > it does?? I know David B
> > recently posted news about an Abiword training
> > document (and it is excellent
> > and we can use it)...and has many others - but
> > what???
> >
> > Maybe we could share this stuff around a little more
> > and make it
> > known...communicate... :)
> >
> > I am using the BIG Computerbank list to get this
> > information out to as many
> > people as i think talking / sharing documentation is
> > something that can
> > benefit us all.
> >
> > Could people please forward this message to relevant
> > folk if they are not on
> > the BIG computerbank mailing list. Thanks.
> >
> > ...More on this topic later.
> >
> > Another thing people may not be aware - there is a
> > cbdocumentation list and
> > project page at Sourceforge (largely its vic based
> > with some interstate
> > presence)...Anyway if anyone wants to join...let me
> > know so I can add you to
> > it. The Sourceforge project page is kinda dead and
> > old...but nonetheless
> > exists at http://sourceforge.net/projects/cbdoc/
> >
> > Cheers,
> >
> > Kylie Davies
> > Victorian State Coordinator
> > Computerbank Australia Inc
> >
> >
> >
> >
> >
> >
> > _______________________________________________
> > The opinions expressed herein are solely those of
> > the individual, and do not
> > express the opinions of Computerbank Australia
> > Incorporated (CAI) in any way.
> > _______________________________________________
> >
> > computerbank mailing list
> > computerbank@lists.linux.org.au
> > http://lists.linux.org.au/listinfo/computerbank
> > Web page: http://www.computerbank.org.au
>
> http://careers.yahoo.com.au - Yahoo! Careers
> - 1,000's of jobs waiting online for you!
> _______________________________________________
> The opinions expressed herein are solely those of the individual, and do not
> express the opinions of Computerbank Australia Incorporated (CAI) in any way.
> _______________________________________________
>
> computerbank mailing list
> computerbank@lists.linux.org.au
> http://lists.linux.org.au/listinfo/computerbank
> Web page: http://www.computerbank.org.au
>
--
__________________________________________________________
Sign-up for your own FREE Personalized E-mail at Mail.com
http://www.mail.com/?sr=signup
_______________________________________________
The opinions expressed herein are solely those of the individual, and do not
express the opinions of Computerbank Australia Incorporated (CAI) in any way.
_______________________________________________
computerbank mailing list
computerbank@lists.linux.org.au
http://lists.linux.org.au/listinfo/computerbank
Web page: http://www.computerbank.org.au