เริ่มต้นด้วยเอกสาร

เราไม่ได้ทำเอกสารใด ๆ ในที่ทำงานของฉัน ฉันใหม่สมบูรณ์และขอคำแนะนำบางอย่างเริ่มต้น

ฉันมีคำถามสองสามข้อ:

• อะไรคือเอกสารสำคัญที่ดูแลระบบควรเขียนและบำรุงรักษา? และทำไมเหล่านี้จึงสำคัญ

• คุณทำเอกสารของคุณให้สอดคล้องกับระบบได้อย่างไร? คุณจะลดความซ้ำซ้อนของข้อมูลได้อย่างไร

• คำแนะนำแนวทางปฏิบัติที่ดีที่สุดรูปแบบการต่อต้าน?

ตั้งแต่ปี 2003 ฉันบันทึกทุกอย่างในวิกิของเรา

เซิร์ฟเวอร์

• รายละเอียดฮาร์ดแวร์
• ข้อมูลการประกัน
• ข้อมูลเครือข่าย
• และแน่นอนติดตั้งซอฟต์แวร์และการกำหนดค่า

เวิร์กโฟลว์

เช่นวิธีการเพิ่มหรือลบผู้ใช้และให้เขา / เธอเข้าถึงบริการที่เกี่ยวข้องทั้งหมด

ลิงค์สำคัญ

• ลิงก์ไปยังเว็บอินเตอร์เฟสของคุณทั้งหมด
• ลิงก์ไปยัง URL การตรวจสอบ (nagios, munin, apc-monitoring ... )
• ลิงก์ไปยังวิกิ (สำหรับเวอร์ชั่นที่พิมพ์ออกมา!)

คำแนะนำฉุกเฉิน

จะทำอย่างไรถ้าเซิร์ฟเวอร์อินทราเน็ต / อินเทอร์เน็ต / เว็บเซิร์ฟเวอร์ / ฯลฯ ไม่ทำงาน

สิ่งสำคัญ:

เลือกเครื่องมือวิกิด้วยการส่งออกเป็น PDF อย่างง่ายดาย!
มันไม่มีประโยชน์ถ้าคุณอยู่ในช่วงวันหยุดเซิร์ฟเวอร์ที่รันวิกิของคุณไม่ทำงานและไม่มีใครรู้ว่าต้องทำอย่างไรเพราะเอกสารของคุณออฟไลน์

ดูที่ twiki, docuwiki หรือ mediawiki

BTW:

มีปลั๊กอิน OpenOffice.orgเพื่อเขียนโดยตรงไปยัง mediawiki - สะดวกมาก

แก้ไข:

/home/adminuser/maintenanceมันยังมีความสุขที่จะเขียนลงข่าวสารบางอย่างเพื่อ สิ่งนี้ทำได้รวดเร็วและมีประโยชน์มากหากผู้ดูแลระบบหลายคนทำงานบนเซิร์ฟเวอร์ เช่น:

2009-06-27 -thorsten-
          running aptitude update && aptitude full-upgrade
          everything seems ok
2009-06-25 -andreas-
          cups-pdf wasn't reachable. restarted cups
2009-06-23 -thorsten-
          deleted old log under /var/log/squid
etc.

ในขณะที่คุณรู้ว่าในขณะที่ทุกคนต้องการเอกสาร (และความต้องการ) คุณต้องจำไว้ว่าไม่มีใครมีเวลาอ่านและศึกษาข้อมูล

ดังนั้นอย่าเขียนเอกสารที่ต้องศึกษาแทนจัดทำเอกสารของคุณในลักษณะที่อนุญาตให้ใครบางคนค้นหาข้อมูลที่ต้องการได้อย่างรวดเร็วเมื่อต้องการ - ซึ่งอาจจะเป็นในขณะที่ระบบล่มและ CTO คือ หายใจลงที่คอของเขา / เธอ

ด้วยความคิดนี้คำแนะนำบางอย่าง ...

• หลีกเลี่ยงบล็อกข้อความขนาดใหญ่
• รายการหัวข้อย่อยเป็นเพื่อนของคุณ
• แผนภาพชัดเจนเป็นสีทอง
• การทำซ้ำเป็นความคิดที่ดี (1)
• ทำให้อัปเดตและขยายได้ง่าย

(1) อย่าสร้างแหล่งความจริงแหล่งเดียวและบังคับให้ผู้คนตามล่ามัน ความคิดที่สำคัญยิ่งคุณควรทำซ้ำ

เอกสารสำคัญ:

• เอกสารเซิร์ฟเวอร์ - รายละเอียด / โครงร่างดิสก์ / ซอฟต์แวร์ที่ติดตั้ง / สิ่งใด ๆ ที่ทราบ
• ขั้นตอนทั่วไป - สิ่งใดก็ตามที่ทำซึ่งไม่ใช่ 'เรื่องไม่สำคัญ' ควรมีขั้นตอนการทำเอกสารโดยเฉพาะอย่างยิ่งหากเป็นสิ่งที่ไม่เคยทำมาก่อน

การจัดทำเอกสารให้ตรงกันอาจเป็นเรื่อง 'แก้ไขเมื่อคุณเห็นข้อผิดพลาด' พร้อมกับสิ่งนี้จะต้องตระหนักว่าเอกสารสามารถและจะล้าสมัยและไม่ควรถูกสุ่มสี่สุ่มห้าโดยไม่คำนึงถึงสิ่งนี้ มีเอกสารเพื่อช่วยผู้ดูแลระบบในงานไม่ใช่เป็นกฎทีละขั้นตอนที่แทนที่ความคิดเชิงวิพากษ์

การลดความซ้ำซ้อน - การใช้บางอย่างเช่นวิกิที่คุณสามารถเชื่อมโยงเอกสารประกอบเข้าด้วยกันสามารถช่วยสิ่งนี้แทนการทำซ้ำข้อมูลคุณเพียงแค่ลิงก์ไปยังเอกสาร ปัญหาคือคนที่เขียนเอกสารนั้นจำเป็นต้องรู้ว่าข้อมูลที่พวกเขากำลังจะทำซ้ำนั้นมีอยู่แล้ว นี่เป็นคำถามขององค์กรที่ดี

ฉันพบว่าการสร้างเทมเพลตเป็นประโยชน์อย่างมาก ในกรณีของฉันมันเป็นแม่แบบ Word แต่ใช้ชุดใดก็ได้ที่คุณ สร้างไฟล์ Skeleton พร้อมด้วยสารบัญและส่วนต่าง ๆ ตามที่ต้องการ เมื่อคุณใช้สองสามครั้งและทำการปรับจูนอย่างละเอียดคุณจะสร้างเอกสารใหม่ได้เร็วขึ้นมาก ความสอดคล้องของรูปแบบจะเป็นประโยชน์อย่างมากทั้งสำหรับการสร้างเอกสารและใช้ในภายหลัง เอกสารจะต้องเก็บไว้ในสถานที่ตรรกะและในโครงสร้างไดเรกทอรีตรรกะ

ฉันไม่เห็นด้วยกับการทำซ้ำเพราะความจริงง่ายๆที่ทำให้ค่าบำรุงรักษาลำบากและเสียเวลาโดยไม่จำเป็น แทนที่จะสร้างเอกสารซ้ำหรือส่วนต่าง ๆ ของเอกสารสร้างการอ้างอิงไปยังเอกสารอื่นตามความเหมาะสม หากมีการเปลี่ยนแปลงบางอย่างคุณไม่ควรเปลี่ยนแปลงเอกสารที่เกี่ยวข้องอีกครั้งหนึ่งครั้งหรือมากกว่าหนึ่งแห่งมิฉะนั้นคุณจะมีการรวบรวมเอกสารที่ขัดแย้งกันซึ่งไม่มีประโยชน์

ในขณะที่สร้างเอกสารของคุณโปรดคำนึงถึงสิ่งที่เป็นประโยชน์ ใครบางคนในภายหลังจะต้องใช้มัน จะสามารถใช้งานได้โดยไม่ต้องมีความรู้มาก่อนหรือไม่?

ไม่ใช่คำตอบที่ตรงกับคำถามของคุณ แต่เป็นตัวชี้ไปในทิศทางที่ถูกต้อง:

ฉันพบว่าการฝึกฝนระบบและการบริหารเครือข่ายโดย Limoncelli และ Hogan (aka Sysadmin Bible) นั้นมีค่าทีเดียวเพราะมันเกี่ยวกับปัญหา "แนวปฏิบัติที่ดีที่สุด" เช่นเอกสาร หากคุณยังไม่รู้เกี่ยวกับเรื่องนี้ตรวจสอบให้แน่ใจว่าคุณตรวจสอบทุกครั้งที่คุณมีโอกาส

สำหรับฉันการพิจารณาที่สำคัญที่สุดคือทำให้ใช้งานง่าย ถ้ามันยากที่จะดัดแปลงผู้คนก็จะหลีกเลี่ยงได้ ฉันเลือกวิกิของTracเป็นสื่อสำหรับเอกสารของเราด้วยเหตุผลเหล่านี้:

• ตั้งอยู่ใจกลางเมือง

  มากกว่าหนึ่งสำเนาที่ใช้งานของเอกสารใด ๆ ที่นำไปสู่ความสับสน หากคุณสามารถอ้างถึงทุกคนในสถานที่เดียวกันทั้งผู้ให้ข้อมูลและผู้ชมคุณสามารถทำให้กระบวนการง่ายขึ้น

• การแก้ไขและการจัดรูปแบบง่าย ๆ

  เสียเวลามากมายในเทมเพลต Word ที่สวยงามและสอดคล้องกับสไตล์ของผู้เขียนคนสุดท้าย หากคุณไม่ทำสิ่งนี้กับคนอื่นคุณก็สามารถแก้ไขได้ในขณะเดินทางและผู้มีส่วนร่วมก็มีแนวโน้มที่จะทำเช่นนั้นมากขึ้น แยกรายการออกมากเท่าที่คุณต้องการด้วย TracLinks

• ประวัติการตรวจสอบ

  สิ่งสำคัญคือต้องรู้ว่าใครทำอะไรเปลี่ยนแปลงเมื่อใดและเพราะเหตุใด หากคุณสามารถผูกเข้ากับคำขอเปลี่ยนแปลงตั๋วและการกำหนดค่ากระทำบันทึกแล้วดีกว่า SVN ส่งมอบ hooks ที่ยอดเยี่ยมสำหรับสิ่งนี้