The tag has no wiki summary.

learn more… | top users | synonyms

52
votes
20answers
16k views

How do you document a network?

I'm not sure how to ask this question, since I'm not in the field. Say you're a network admin and you leave your job. How does the new guy know where to start?
16
votes
9answers
1k views

Documentation As-A-Manual vs. Documentation As-A-Checklist

I've had discussions in the past with other people in my department about documentation, specifically, level-of-detail and requirements. In their view, documentation is a simple checklist of Y things ...
16
votes
5answers
4k views

How do I write man pages? [closed]

How do I write a man page? Where can I find a reference of all formatting codes? Are there any good tutorials on writing man pages? What is the most convenient way to write a man page? Should I ...
14
votes
6answers
1k views

Getting started with documentation

We haven't been doing any documentation at my workplace. I'm completely new to it and ask for some guidance getting started. I have a few questions: What are the essential documents that a ...
14
votes
4answers
1k views

IT Documentation with MediaWiki

We are looking for ways in which to further enhance our documentation and our ability to allow easy access to the information as well as editing the information. With these ideas in mind, we created ...
13
votes
6answers
555 views

Where can I document useful things to know as a Mac sysadmin?

I've recently done some research on the directory service tools on the Mac (dscl, dsimport, dsexport), and would like to be able to document them somewhere for all to benefit (and perhaps where my ...
12
votes
6answers
6k views

free tool for datacenter documentation [closed]

Is there any free tools out there that can help to better document at datacenter, for information like servers in a rack, the group port it is connected to and etc?
12
votes
5answers
13k views

How do you document windows server configurations?

I come from a Unix background where documenting the configuration of a service (email for example) could be as simple as grabbing a few text configuration files and a paragraph or 2 of explanatory ...
12
votes
2answers
7k views

Anything Close to an NSA Guide for Securing RHEL 6 [closed]

Some in our infrastructure group want to upgrade to start taking advantage of the new features in RHEL 6. In the past, I have relied on the NSA Guide ...
11
votes
4answers
1k views

Industry Standards for Network Infrastructure Labeling

Are there any current industry standards IEEE, ISO, ANSI.... available that state how a buildings physical infrastructure should be labeled at the rack and jack and how the documentation should be ...
10
votes
6answers
5k views

How to document linux server configuration?

I have about 20 linux servers which I need to document the configuration of. I do not mean the detailed configuration of services, but rather user accounts, databases, databases accounts, ip ...
8
votes
4answers
6k views

What is important to document in an active directory server?

Later this year I will be handing over support of my church’s active directory servers to someone else and would like to know what kind of information is important to document and share. Are there any ...
7
votes
6answers
759 views

Documenting server details

This could be a very naive question for many of you, but I have problem in answering this one, your help will be deeply appreciated. I need to document the server on which I work, and it should ...
7
votes
3answers
274 views

How do you avoid that server documentation gets out of sync with the actual setup?

We have have reasonably good documentation for our environment (in AsciiDoc format) which recently allowed another person to recreate the entire setup from scratch in less than 30 minutes. However, I ...
7
votes
2answers
224 views

documenting a schools pcs and network (voluntary)

My daughter’s school have several networked pcs (various OS), printers, networked interactive white boards (connect to the internet, stream media etc). They have a parent who was looking after ...
7
votes
4answers
1k views

How do you document your Cisco configurations?

How do you document your Cisco configurations? How much / what kind of information do you include in the description field (connects to, circuit ID, device information, etc.)? Do you use any ...
6
votes
3answers
3k views

Where can I find introductory documentation for ZFS?

I recently installed OpenIndiana because of an interest in ZFS. I like the feature-list of ZFS, but I'm having a hard time wrapping my head around how to configure it. All of the documentation I ...
6
votes
5answers
6k views

What's the difference between a Disaster Recovery Plan and a Business Continuity Plan?

I used to think both terms referred to the exact same thing, but one of my clients just requested to have a look at both documents. The request emanates from the security department of a very big ...
6
votes
1answer
324 views

Are there standards/conventions used by IT technical writers?

TL:DR? Fine...here: Short of hiring or outsourcing to a Tech Writer, are there basic standards/conventions/practices that Technical Writers employ in their trade that can be learned from in order to ...
5
votes
5answers
629 views

What's the best platform to publish documentation to internal users?

My team has a need to publish documentation internally. At the moment, it's spread all over the place and this means we often have to search everywhere to find something. We'd like to publish ...
5
votes
8answers
5k views

creating decision tree based troubleshooting documentation?

We troubleshoot a lot of server and network issues and follow a loose set of steps on what to do in different cases. With more and more people and responsibility, the need for standardization is ...
5
votes
1answer
166 views

Linux I/O buffering reference

Can someone point me to a fairly complete reference on the Linux I/O system, primarily how all the buffers and caches are handled and flushed? My understanding so far is that there are Application ...
4
votes
3answers
91 views

IP address range for examples in documentations

Is there an IP address range dedicated to example in documentations ? (Like example.com for DNS)
4
votes
2answers
11k views

Dell fumbles OpenManage installation process, forgets to write documentation?

I'm setting up a Dell PowerEdge 2950 for a small business, and I've just spent a while with Dell OpenManage Server Administrator 6.2, trying to clear the installation process of errors before I ...
4
votes
3answers
461 views

Documenting Job Schedules?

Once upon a time, I thought I found the perfect way to document all scheduled jobs across all servers. I used Google Calendar and created a cal for each server and then added all the jobs as scheduled ...
4
votes
1answer
1k views

server handover document template - users, security settings (firewall,selinux), packages etc

As part of the handover of our linux application server automated builds I would like to produce a high level "handover document" which captures the key functions and config items. (This is more of a ...
3
votes
11answers
2k views

What do i use to hold the server documentation?

I had to document the servers i use and i don't know what to use to hold the data. Could you sugest the best way to keep the server documentation? Do i create a data base that holds the harware and ...
3
votes
4answers
365 views

What's new in Puppet since 2007?

I've got a copy of the Pulling Strings with Puppet book (written in 2007) but given that it has a bunch of equivocal language, I'm wonder how much has changed since then? I've found this Release Notes ...
3
votes
1answer
462 views

Powershell and NMAP Information Sharing

I am working on a project where I would like to perform host documentation for a variety of items. Part of these items would be sourced from Powershell and the rest would be sourced from NMAP. For ...
3
votes
3answers
481 views

Documenting port numbers on floor plan

I want to be able to create a simple floor plan and document where all the ports are located and what there number is. Is there any good software to help with this. Preferably open source / free.
3
votes
2answers
1k views

Migrating from MyISAM to XtraDB

Just a few questions that I just can't find anywhere about migrating to XtraDB. My group has been using MyISAM dbs for production and was wondering how hard is it to migrate to Percona's XtraDB and ...
3
votes
4answers
6k views

Cisco 48 port switch template diagram

We have just taken delivery of a 'mature' 48 port switch for testing, deployment and general skulduggery. Since we are going to be constantly mucking around with the patching we need a diagram so we ...
3
votes
2answers
129 views

Documentation for native modules in IIS 7.x

I've been working for some time at a super lean IIS 7.5 configuration for a static file serving purposes web site. To achieve this, I've simply stripped the designated web site for all dynamic ...
3
votes
2answers
666 views

Looking for good documentation of odbc.ini and odbcinst.ini files on Linux

I saw partial information, old information, but nothing as good as the actual sample files with brief comments that I have locally. I need to understand the exact relationship between odbc.ini and ...
3
votes
2answers
1k views

Is there reference documentation for CloudInit?

Ubuntu's CloudInit package is very useful; however, the only documentation I've found on all of the available options is in their examples: ...
3
votes
4answers
142 views

How do you write a Linux deployment documentation / plans?

I have few, relatively small, servers running Linux distros. Sometimes I need to re-install 1 or 2 of the "development" servers from scratch. Often I just forget to setup little things, eg. forwarding ...
3
votes
1answer
460 views

What are we supposed to document of our server infrastructure?

It's very important to have decent and good documentation. The problem is that often we might have good documenting techniques, but we forget some crucial points. It can be extremely painful to find ...
2
votes
5answers
701 views

Unable to understand Unix 'find' commands’ manuals completely

I find the synopsis of Find's manual difficult to read Let's assume that you are finding directories with 777 permissions. Pixelbeat's suggestion is find -type d ! -perm -777 My OS/X gives the ...
2
votes
4answers
377 views

How to visually document IT processes?

Our company has 8 departments each housing approximately 12 people on average. I'm the CTO of the company and IT is involved in pretty much all departments. As such, there is a need to define and ...
2
votes
3answers
331 views

Documenting the configuration of Windows Server 2003?

Are there any tools that can be used to document configuration of Windows Server 2003? By configuration I mean: Services installed Programs installed Users IIS config UPDATE1: Simplified ...
2
votes
4answers
1k views

Where is a user guide for Alfresco?

Where is a user guide for Alfresco like exits for Nuxeo: Nuxeo Document Management: the User Guide
2
votes
2answers
584 views

How to document mail setup after hand-over

I've just moved a client's email services over from my host to Google Apps. I would like to hand over a document providing all they (or their agent) need should I not be available etc. How are such ...
2
votes
6answers
403 views

How to deliver documentation for IT tools?

I'd like to deliver an IT tool for use on Windows. The thing is an ISAPI Filter, and I want to describe installation, operations, and configuration. Currently this is done in a text file, which is ...
2
votes
1answer
54 views

centos yum repository package security information.. how do i find it?

Is there anywhere that shows which security updates are included in the patch levels for centos yum repository package version of httpd?
2
votes
4answers
108 views

Source for documentation on circa 2000 HP hardware?

A previous employer has asked me to come by and see if I can resurrect a computer which has failed since I left -- 8 years ago. The computer in question is a HP 9000 rp2430, HP part A6889A (A Class ...
2
votes
4answers
327 views

Complex software installation documentation procedures or tools

We have to distribute and maintain a somewhat complex software application, whose installer does not (nor is expected to) install and configure every part needed on any possible kind of server. I've ...
2
votes
1answer
63 views

output MOSS 2010 configuration for documentation purposes

When writing documentations about a system I usually can use the sysinfo command on the command line to output most configurations and Hardware Specs. This saves a lot of time and makes the job of ...
2
votes
1answer
164 views

Inventory tool to document customers services and associated network connectivity details?

Has anyone a recommendation for an inventory tool to document: customers, services associated by each customer, network connectivity details (IP, TCP, ftp, http): typically local and remote TCP ...
2
votes
1answer
56 views

Need advice on documenting LAMP web site

I need to document my web site. It is a music web site on Linux/Apache/MySQL/PHP on AWS. I need to document everything: architecture (5 servers), database (100+ tables), php classes, programming ...
2
votes
1answer
1k views

HTTP 404 - /docs/appdev/ on fresh netbeans tomcat 7 install

As part of re-installing NetBeans 7.0.1, I had Tomcat 7.0.14 installed too on my PC. I created a manager role too. I can access http://localhost:8084/manager/html successfully. <role ...