Server Fault Stack Exchange
Server Fault Stack Exchange

Questions tagged [documentation]

118 questions
8
votes
1 answer

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 create proper IT documentation and maintain that…
TheCleaner
  • 32,627
  • 26
  • 132
  • 191
8
votes
3 answers

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 noticed that after the initial setup, it easily…
Frerich Raabe
  • 801
  • 7
  • 16
8
votes
7 answers

What level of documentation do you expect to be provided to you by developers?

Title says it all really. It can sometimes end up that development and IT are at loggerheads over this sort of thing. What level of documentation do you expect when you're expected to install, patch, maintain, start, stop and diagnose a solution…
cletus
  • 9,999
  • 9
  • 37
  • 40
7
votes
4 answers

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 automated tools, such as Rancid, to do automatic…
Peter
  • 5,453
  • 1
  • 26
  • 32
7
votes
6 answers

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 include following heads: IP address -> Model->…
Angelo
  • 169
  • 4
7
votes
2 answers

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 everything who is no longer interested. The school has…
armitage
  • 171
  • 2
6
votes
2 answers

Properly documenting installations of seldom used new technologies

I've been tasked with looking if a combination of NoSQL (in this case possibly Neo4J) and SQL-Server is a possible solution for a performance problem we've been having. Part of my technical analysis is the maintainability and stability of the…
Reaces
  • 5,597
  • 4
  • 38
  • 46
6
votes
5 answers

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 company, so I guess they know what they're talking…
Brann
  • 630
  • 1
  • 9
  • 19
6
votes
3 answers

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 have come across so far seems to presuppose an…
Steve Rowe
  • 223
  • 4
  • 7
6
votes
1 answer

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 buffers (including fread/fwrite buffers allocated…
Ben Jencks
  • 1,361
  • 8
  • 13
6
votes
6 answers

New Sys Admin job...Where do I begin?

I'm looking for some general advice here. I've decided to take my first job in a lead sys admin position...I don't start until next month, but in the meantime I'd like to prepare for the position. For those of you that have walked into this role at…
Windows Ninja
  • 2,586
  • 19
  • 46
  • 70
5
votes
8 answers

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 needed so we don't miss something. I know I could…
Joseph
  • 3,797
  • 27
  • 33
5
votes
2 answers

Bash commands run at terminal but not in Jenkins/Bash Script

I'm using Jenkins to build and deploy HTML documentation to a local Apache web server for our devs to use. When I run the commands in the terminal, everything installs properly (Proving the server is setup properly). However, when run the same…
Sean Michael Dorian
  • 153
  • 1
  • 1
  • 5
5
votes
1 answer

HAProxy listen with two arguments?

I keep seeing HAProxy configuration examples with a two-argument syntax. Indeed, the default configuration file supplied with 1.4.18 contains this: listen appli1-rewrite 0.0.0.0:10001 cookie SERVERID rewrite balance roundrobin server …
SystemParadox
  • 847
  • 9
  • 14
5
votes
11 answers

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 software documentation, or do i use wiki pages or…
Radu
  • 165
  • 1
  • 5
1
2
3 4 5 6 7 8