Difference between revisions of "IT Documentation"

m
(Tag: 2017 source edit)
 

BlueSpice is the knowledgebase for (almost) all IT documentation.

The wiki as IT documentation tool
Ideal use cases Possible, but not ideal use cases
  • IT process management (e.g., IT emergency manual)
  • Software documentation and referenzesreferences
  • Online help, FAQ und How-to's
  • Customer and installation documentation
  • IT projekt project documentation (z.B. rollout of new services)
  • Compiling inventories
  • Cable management
  • IP adress address management (IPAM)

Example pages[edit | edit source]

The following pages give you some ideas for using the wiki for IT documentation:

BlueSpice is the knowledgebase for (almost) all IT documentation. 
        
        {| class="wikitable toptextcells"
        
        |+The wiki as IT documentation tool
        
        !Ideal use cases
        
        !Possible, but not ideal use cases
        
        |- style="vertical-align:top"
        
        |
        
        *IT process management (e.g., IT emergency manual)
        
        *Software documentation and referenzesreferences
        
        *Online help, FAQ und How-to's
        
        *Customer and installation documentation
        
        *IT projektproject documentation (z.B. rollout of new services)
        
        *Compiling inventories
        
        |
        

        *Cable management
        
        *IP adressaddress management (IPAM)
        
        |}
        
        ==Example pages==
        
        The following pages give you some ideas for using the wiki for IT documentation:
        

        *Example of [[YourCompany/Documentation|Customer documentation]] for [[YourCompany]]
        
        *Graphical process description: [[Relocation of IT Staff]]
        
        *Code editing: [[YourCompany/Production System#Docker|Example Bash]] or [[Object-oriented Programming with JavaScript|JavaScript]]
Line 7: Line 7:
 
|
 
|
 
*IT process management (e.g., IT emergency manual)
 
*IT process management (e.g., IT emergency manual)
*Software documentation and referenzes
+
*Software documentation and references
 
*Online help, FAQ und How-to's
 
*Online help, FAQ und How-to's
 
*Customer and installation documentation
 
*Customer and installation documentation
*IT projekt documentation (z.B. rollout of new services)
+
*IT project documentation (z.B. rollout of new services)
 
*Compiling inventories
 
*Compiling inventories
 
|
 
|
  
 
*Cable management
 
*Cable management
*IP adress management (IPAM)
+
*IP address management (IPAM)
 
|}
 
|}
 
==Example pages==
 
==Example pages==

Attachments

Discussions