Difference between revisions of "IT Documentation"

(First translation EN)
 
 

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
  • Wiring 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
        
        |
        
        
        
        *WiringCable management
        
        *IP adressaddress management (IPAM)
        
        |}
        
        ==Example pages==
        
        The following pages give you some ideas for using the wiki for IT documentation:
        
        
        
        *Example of [[Yourcompany IncYourCompany/Documentation|Customer documentation]] for [[Yourcompany IncYourCompany]]
        
        *Graphical process description: [[Relocation of IT staffStaff]]
        
        *Code editing: [[Yourcompany IncYourCompany/Production System#Docker|Example Bash]] or [[Object-oriented Programming with JavaScript|JavaScript]]
(2 intermediate revisions by one other user not shown)
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
 
|
 
|
  
*Wiring management
+
*Cable management
*IP adress management (IPAM)
+
*IP address management (IPAM)
 
|}
 
|}
 
==Example pages==
 
==Example pages==
 
The following pages give you some ideas for using the wiki for IT documentation:
 
The following pages give you some ideas for using the wiki for IT documentation:
  
*Example of [[Yourcompany Inc/Documentation|Customer documentation]] for [[Yourcompany Inc]]
+
*Example of [[YourCompany/Documentation|Customer documentation]] for [[YourCompany]]
*Graphical process description: [[Relocation of IT staff]]
+
*Graphical process description: [[Relocation of IT Staff]]
*Code editing: [[Yourcompany Inc/Production System#Docker|Example Bash]] or [[Object-oriented Programming with JavaScript|JavaScript]]
+
*Code editing: [[YourCompany/Production System#Docker|Example Bash]] or [[Object-oriented Programming with JavaScript|JavaScript]]

Attachments

Discussions