GeneralThis forum is for non-technical general discussion which can include both Linux and non-Linux topics. Have fun!
Notices
Welcome to LinuxQuestions.org, a friendly and active Linux Community.
You are currently viewing LQ as a guest. By joining our community you will have the ability to post topics, receive our newsletter, use the advanced search, subscribe to threads and access many other special features. Registration is quick, simple and absolutely free. Join our community today!
Note that registered members see fewer ads, and ContentLink is completely disabled once you log in.
If you have any problems with the registration process or your account login, please contact us. If you need to reset your password, click here.
Having a problem logging in? Please visit this page to clear all LQ-related cookies.
Get a virtual cloud desktop with the Linux distro that you want in less than five minutes with Shells! With over 10 pre-installed distros to choose from, the worry-free installation life is here! Whether you are a digital nomad or just looking for flexibility, Shells can put your Linux machine on the device that you want to use.
Exclusive for LQ members, get up to 45% off per month. Click here for more info.
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
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.
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.
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.
LinuxQuestions.org is looking for people interested in writing
Editorials, Articles, Reviews, and more. If you'd like to contribute
content, let us know.