LinuxQuestions.org
Latest LQ Deal: Latest LQ Deals
Go Back   LinuxQuestions.org > Forums > Non-*NIX Forums > General
User Name
Password
General This forum is for non-technical general discussion which can include both Linux and non-Linux topics. Have fun!

Notices


Reply
  Search this Thread
Old 02-19-2010, 09:55 AM   #1
sycamorex
LQ Veteran
 
Registered: Nov 2005
Location: London
Distribution: Slackware64-current
Posts: 5,833
Blog Entries: 1

Rep: Reputation: 1229Reputation: 1229Reputation: 1229Reputation: 1229Reputation: 1229Reputation: 1229Reputation: 1229Reputation: 1229Reputation: 1229
documenting what you do at work


Browsing through some computer job ads I have come across the phrase 'documenting' your tasks as a part of job description.
I can vaguely guess what it would consist in but I am not sure what kind of things you'd normally document. The most obvious one would be some sort of settings so that if anyone else has to do anything on a particular machine/server/network, they don't have to spend hours finding out config information.
Is there any particular format or software that is used as standard? Are they just plain text files?
thank you
 
Old 02-19-2010, 09:58 AM   #2
rweaver
Senior Member
 
Registered: Dec 2008
Location: Louisville, OH
Distribution: Debian, CentOS, Slackware, RHEL, Gentoo
Posts: 1,833

Rep: Reputation: 164Reputation: 164
A lot of companies are moving internal documentation onto a wiki or into a document management system of some kind. As far as what documentation is done and at what detail level it varies company to company.
 
Old 02-19-2010, 10:02 AM   #3
XavierP
Moderator
 
Registered: Nov 2002
Location: Kent, England
Distribution: Debian Testing
Posts: 19,192
Blog Entries: 4

Rep: Reputation: 475Reputation: 475Reputation: 475Reputation: 475Reputation: 475
We use a mix of internal wiki, MS Sharepoint and lots and lots of Word files. It really depends on how the info needs to be presented (internal team instruction, full on process documentation or whatever).

And as this isn't a linux technical question, I have moved it to General.
 
Old 02-19-2010, 10:35 AM   #4
sycamorex
LQ Veteran
 
Registered: Nov 2005
Location: London
Distribution: Slackware64-current
Posts: 5,833

Original Poster
Blog Entries: 1

Rep: Reputation: 1229Reputation: 1229Reputation: 1229Reputation: 1229Reputation: 1229Reputation: 1229Reputation: 1229Reputation: 1229Reputation: 1229
Thanks for your replies. I think I get the idea.
I googled a bit on document management systems, and these are some examples I found:
dokuwiki, opendocman, simplegroupware

I might use it myself as I've got quite a lot of short how-tos gathered from the internet and
adapted to my settings and would like to organise them somehow. I'd have to clean them up a bit
as at the moment they are VERY messy and probably understandable only by me.
 
  


Reply


Thread Tools Search this Thread
Search this Thread:

Advanced Search

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is Off
HTML code is Off



Similar Threads
Thread Thread Starter Forum Replies Last Post
Documenting a DNS Caching Server? morphix Linux - Server 1 03-03-2009 06:02 PM
Documenting C code CoderMan Programming 10 02-08-2009 01:07 AM
Seeking documenting programs Berticus Linux - Software 3 08-21-2007 05:57 PM
documenting c code sibtay Programming 2 01-02-2005 04:07 AM

LinuxQuestions.org > Forums > Non-*NIX Forums > General

All times are GMT -5. The time now is 09:03 AM.

Main Menu
Advertisement
My LQ
Write for LQ
LinuxQuestions.org is looking for people interested in writing Editorials, Articles, Reviews, and more. If you'd like to contribute content, let us know.
Main Menu
Syndicate
RSS1  Latest Threads
RSS1  LQ News
Twitter: @linuxquestions
Facebook: linuxquestions Google+: linuxquestions
Open Source Consulting | Domain Registration