Difference between revisions of "Wiki"

From AccountIT
Jump to: navigation, search
(Processes description)
(Common wiki tags)
 
(35 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= Introduction =
+
 
The wiki provides documentation for both the product (i.e. "the requirements") as well as the work processes required to develop, deploy, operate and support the systems.
+
  
 
= Wiki structure =
 
= Wiki structure =
== System requirements ==
+
==Common wiki stuff==
The requirements are based [http://www.opengroup.org/togaf/ TOGAF], with the overall vision described under [[AccountIT]], while the product for customers is described under [[Product]]. The requirements for the support systems is described under [[Internal]], and finally the requirements for the platform that is to support both the customer product as well as the support systems is described under [[Platform]]
+
*[[Wiki Mediawiki Information|Common wiki Information]]
 +
*[[Wiki Mediawiki Understanding|Common wiki definitions]]
 +
*[[Wiki Page Naming|Page Naming]]
 +
* SpecialPages are wiki pages that can not be edit as they have special functions inside the wiki setup
 +
** an example of a special wikipage is [[Special:AllPages]]
 +
 
 +
==Common wiki tags==
 +
Mediawiki is one of the wikiengines that gives most build-in tags for use. Here are a list of the most common tags:
 +
 
 +
 
 +
<nowiki> [[Link to wiki-page]] </nowiki>
 +
 
 +
<nowiki> [[Some page|link with custom text]] </nowiki>
 +
 
 +
<nowiki> ==HEADER 1== </nowiki>
 +
 
 +
<nowiki> ===HEADER 2=== </nowiki> (etc.)
 +
 
 +
<nowiki> ''Italic text'' </nowiki>
 +
 
 +
<nowiki> '''Bold text''' </nowiki>
 +
 
 +
<nowiki> * Bulletes list </nowiki>
 +
 
 +
<nowiki> # Numbered list </nowiki>
 +
 
 +
===Advanced formatting features===
 +
* Rich set of features for controlling content display
 +
* Many HTML-like features supported (<sub>, style, ....)
 +
* Advanced formatting elements:
 +
** Images
 +
** Tables
 +
 
 +
(see online dokumentation for details)
 +
 
 +
==Navigation==
 +
* Breadcrumbs
 +
* Left side menubar
 +
==Links==
 +
[[Links]]
 +
 
 +
=Wiki toobox=
 +
Navigate to [[Special:Version]] on your wiki to verify what extension that is successfully installed.
 +
==Categories==
 +
[[Categories]], a software feature of wiki, provide automatic indexes that are useful as tables of contents.
 +
 
 +
You can categorize pages and files by adding one or more Category tags to the content text. These tags create links at the bottom of the page that take you to the list of all pages in that category, which makes it easy to browse related articles.
 +
==UML==
 +
The '''PlantUML''' extension allows to easily add [[UML]] diagrams into Wiki using a simple text description.
 +
 
 +
The following diagrams are available:
 +
* sequence diagram,
 +
* use case diagram,
 +
* class diagram,
 +
* activity diagram,
 +
* component diagram,
 +
* state diagram
 +
 
 +
The language is explained in this document:
 +
[http://sourceforge.net/projects/plantuml/files/PlantUML%20Language%20Reference%20Guide.pdf/download Language Reference Guide.pdf]
 +
 
 +
==Graphviz==
 +
Graphviz is open source graph visualization software. Graph visualization is a way of representing structural information as diagrams of abstract graphs and networks. It has important applications in networking, bioinformatics,  software engineering, database and web design, machine learning, and in visual interfaces for other technical domains.
 +
* [[UML#Example4 |Example]]
 +
* [http://www.graphviz.org/ www.graphviz.org]
 +
* [http://www.graphviz.org/Documentation.php www.graphviz.org/Documentation]
 +
 
 +
 
 +
 
  
== Process description ==
+
[[Category:Manual]]
The different processes are divided into sections. Each covering its part of the life cycle for the systems. [[Development processes]] covers the development tasks till the point the software is ready for launch (i.e. ready for customers to use). [[Operation processes]] covers the deployment of the software, monitoring the systems and handling events (such as "out of disc space"). [[Support processes]] covers the processes required for supporting the business by handling "service requests" as well as billing customers.
+
[[Category:Wiki]]

Latest revision as of 00:17, 27 March 2015


Wiki structure

Common wiki stuff

Common wiki tags

Mediawiki is one of the wikiengines that gives most build-in tags for use. Here are a list of the most common tags:


 [[Link to wiki-page]] 
 [[Some page|link with custom text]] 
 ==HEADER 1== 
 ===HEADER 2===  (etc.)
 ''Italic text'' 
 '''Bold text''' 
 * Bulletes list 
 # Numbered list 

Advanced formatting features

  • Rich set of features for controlling content display
  • Many HTML-like features supported (, style, ....)
  • Advanced formatting elements:
    • Images
    • Tables

(see online dokumentation for details)

Navigation

  • Breadcrumbs
  • Left side menubar

Links

Links

Wiki toobox

Navigate to Special:Version on your wiki to verify what extension that is successfully installed.

Categories

Categories, a software feature of wiki, provide automatic indexes that are useful as tables of contents.

You can categorize pages and files by adding one or more Category tags to the content text. These tags create links at the bottom of the page that take you to the list of all pages in that category, which makes it easy to browse related articles.

UML

The PlantUML extension allows to easily add UML diagrams into Wiki using a simple text description.

The following diagrams are available:

  • sequence diagram,
  • use case diagram,
  • class diagram,
  • activity diagram,
  • component diagram,
  • state diagram

The language is explained in this document: Language Reference Guide.pdf

Graphviz

Graphviz is open source graph visualization software. Graph visualization is a way of representing structural information as diagrams of abstract graphs and networks. It has important applications in networking, bioinformatics, software engineering, database and web design, machine learning, and in visual interfaces for other technical domains.