+ Post New Thread
Results 1 to 10 of 10
General Chat Thread, System Documentation in General; I'm painfully aware that there is little system documentation here. It's either in my head or a scrappy notebook in ...
  1. #1


    Join Date
    Sep 2007
    Location
    UK
    Posts
    5,434
    Thank Post
    1,441
    Thanked 886 Times in 568 Posts
    Rep Power
    646

    System Documentation

    I'm painfully aware that there is little system documentation here. It's either in my head or a scrappy notebook in my pocket. If I were to be run over by a bus or attacked by an Apache helicopter, the poor s*d who came in would have a bit of a nightmare on his hands. So, my New Year Resolution is to write a systems manual or a set of notes explaining how it works. So, if you were that poor s*d, what would you like to see. I'd planned to do it as a series of bullet-points but I'm open to suggestions.

    I realise that this may produce rather a long list, so maybe if you limit yourself to 5 items to start with. Who know, maybe we will end up with a de facto document, so that any technician can walk into any school, pick up the document and get stuck in. Do I see flying pigs?

  2. #2

    SYNACK's Avatar
    Join Date
    Oct 2007
    Posts
    11,174
    Thank Post
    868
    Thanked 2,703 Times in 2,289 Posts
    Blog Entries
    11
    Rep Power
    773

    Re: System Documentation

    I would probably break it down into several categories:

    Network Configuration:
    -ip config (address space, scope, fixed ips, routing tables if you use them)
    -services config (DHCP, DNS, AD)
    -server responsibilities(which server does what)

    Hardware Configuration:
    -how switches, routers and servers are connected together + config backups
    -what spec these components are
    -as much information on the workstations as you can be bothered adding ie specs

    Software Configuration:
    -what software programs are installed throughout the school, how and where they are installed.

    Procedures:
    -how to build a new machine (software wise)
    -adding users (any special procedure) - depends on how documentation happy you are at the time
    -etc.

  3. #3
    ChrisH's Avatar
    Join Date
    Jun 2005
    Location
    East Lancs
    Posts
    5,009
    Thank Post
    120
    Thanked 282 Times in 260 Posts
    Rep Power
    108

    Re: System Documentation

    Get it on a wiki. Its nice and easy to search/update then.

  4. #4
    DSapseid's Avatar
    Join Date
    Feb 2007
    Location
    West Sussex
    Posts
    1,152
    Thank Post
    130
    Thanked 54 Times in 47 Posts
    Rep Power
    38

    Re: System Documentation

    There was another recent discussion about this here.

    Mine is currently 20 pages long and growing. 8O

  5. #5

    dhicks's Avatar
    Join Date
    Aug 2005
    Location
    Knightsbridge
    Posts
    5,625
    Thank Post
    1,240
    Thanked 778 Times in 675 Posts
    Rep Power
    235

    Re: System Documentation

    > how switches, routers and servers are connected together

    Nothing beats a nice electronic format plan of the school of some sort, with different layers showing cables, switches, network points, etc. We use Inkscape to do an SVG format plan with layers, but Photoshop or similar, or a piece of dedicated diagramming software (or even AutoCad), would also be good.

    --
    David Hicks

  6. #6
    mortstar's Avatar
    Join Date
    Jan 2007
    Location
    Oxford
    Posts
    341
    Thank Post
    13
    Thanked 29 Times in 18 Posts
    Rep Power
    21

    Re: System Documentation

    Quote Originally Posted by DSapseid
    There was another recent discussion about this here.

    Mine is currently 20 pages long and growing. 8O
    From this discussion I saw webman's wiki, which I thought was perfect.

    I've just finished the DokuWiki install onto Ubuntu, some great feature like LDAP authentication. Now all I've got to do is create some content :? ...

    ...or maybe I'll just tweak the layout a bit more

  7. #7

    webman's Avatar
    Join Date
    Nov 2005
    Location
    North East England
    Posts
    8,406
    Thank Post
    639
    Thanked 961 Times in 661 Posts
    Blog Entries
    2
    Rep Power
    324

    Re: System Documentation


  8. #8
    Pete10141748's Avatar
    Join Date
    Nov 2007
    Posts
    1,365
    Thank Post
    106
    Thanked 220 Times in 130 Posts
    Rep Power
    86

    Re: System Documentation

    I spent a few hours last week creating this kind of document. Its only simple, but it should be enough for anyone who actually has a bit of IT klnowledge. I had basically all of the stuff that SYNACK mentioned in his post above.


    Table of Contents

    Network Overview - basic introduction
    Internet Access - configuration of proxy / ports etc
    Servers
    Primary Server - IP address, roles, spec etc
    Secondary Server - roles, spec etc
    Espresso - cachepoilot config, location, access

    Hubs and Switches
    Upper school hub cabinet - location, configuration, free space
    Lower school hub cabinets - location, configuration, free space
    Fax Room hubs - location, configuration, free space
    ICT Suite hubs - location, configuration, free space

    Admin Department

    Reception - PC specs, programs, roles, users, accounts, IP addresses

    Finance - PC specs, programs, roles, users, accounts, IP addresses

    Other PC’s
    ICT Suite - specs, number of PCs, names, programs, age
    Classroom PC’s - specs, number of PCs, names, programs, age
    Staffroom - specs, number of PCs, names, programs, age

    Laptops; Overview
    Staff Laptops - specs, names, programs, age, user
    Pupil / Education laptops - specs, number of PCs, names, programs, age

    Printers / Photocopiers - location, age, capabilities
    E-Mail account
    ICT Office; General information

    Appendices;

    Appendix A: Full list of school software - name, age, compatability, use, where installed,
    Appendix B: Profile information - how to set up a new profile for staff / students
    Appendix C: Map and Key for both sites showing equipment location
    Appendix D: Full Laptop List - specs, assigned to, age, serial number, name
    Appendix E: Printer List - specs, type, serial number / MACs, location
    Appendix F: Desktop PC’s - specs, assigned to, age, serial number, name
    Appendix G: WAPs and Projectors - specs, assigned to, age, serial number / MACs, name


    I'll probably add more as the need comes up. Its also prety useful to me as well to have all that info in one place, just in case I ever do forget something!

    Pete

  9. #9
    sahmeepee's Avatar
    Join Date
    Oct 2005
    Location
    Greater Manchester
    Posts
    795
    Thank Post
    20
    Thanked 70 Times in 42 Posts
    Rep Power
    34

    Re: System Documentation

    This is a good starting point for your servers:

    http://sydiproject.com/products/sydi-server

    You can run it remotely against all your servers to make a Word doc for each one which can then be augmented with the stuff the script can't pick up like the physical location etc.

  10. #10

    plexer's Avatar
    Join Date
    Dec 2005
    Location
    Norfolk
    Posts
    13,621
    Thank Post
    648
    Thanked 1,620 Times in 1,450 Posts
    Rep Power
    421

    Re: System Documentation

    There's also a lite tool from ecora that does this.

    Ben

SHARE:
+ Post New Thread

Similar Threads

  1. server documentation
    By plexer in forum Wired Networks
    Replies: 9
    Last Post: 13th April 2012, 10:36 PM
  2. Censornet documentation
    By markman in forum *nix
    Replies: 4
    Last Post: 19th October 2007, 10:22 AM
  3. Documentation
    By phillipmillward in forum School ICT Policies
    Replies: 0
    Last Post: 1st April 2007, 06:18 PM
  4. R2 documentation
    By tosca925 in forum Windows
    Replies: 11
    Last Post: 22nd November 2006, 09:08 AM
  5. Network Documentation
    By u8dmtm in forum Wireless Networks
    Replies: 1
    Last Post: 23rd February 2006, 12:35 PM

Thread Information

Users Browsing this Thread

There are currently 1 users browsing this thread. (0 members and 1 guests)

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •