Last edited 2 years ago
by Demo writer

YourCompany/Documentation and Technical documentation: Difference between pages

(Difference between pages)
VisualWikitext
No edit summary
 
No edit summary
Tag: 2017 source edit
 
Line 1: Line 1:
{{TOClimit|limit=2}}
BlueSpice is the platform for technical documentation.
<bs:universalexport:pagebreak />
{| class="wikitable"
==Management Summary==
|+Wiki as a tool for technical documentation
YourCompany has organizational wikis.
! style="background-color:rgb(234, 236, 240);text-align:center;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |External technical documentation
 
! style="background-color:rgb(234, 236, 240);text-align:center;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Interne Technische Dokumentation
The organization wikis vary in size, some have a size of only a few pages. About 5 wikis have a much larger size. All model company wikis have a total of about 400 users.
 
The following procedure has been defined:
 
*Users are currently managed by SAML. In addition, access to the individual wikis should be controlled via SAML.
<bs:universalexport:pagebreak />
 
==Server Infrastructure==
===Server environment===
{| class="contenttable-blue" width="100%"
|-
! style="width:300px;" |Server
!Server name
!URL
!Configuration
|-
||Production System
||rz14.yourcompany.local
|https://wiki.yourcompany.de/
|Ubuntu 16.04.
8 CPUs
 
32 GB RAM
|-
||Development System
||rz14.yourcompany.local
|[https://wiki.yourcompany.de/ https://wiki-a.yourcompany.de]
|Ubuntu 16.04.
8 CPUs
 
32 GB RAM
|}
 
===Setup BlueSpice pro with WikiFarm===
 
====BlueSpice pro Services:====
=====Services for the operation of BlueSpice pro:=====
 
*Webserver (Apache) with PHP
*Database (MariaDB)
 
=====Additonal Services:=====
{| class="contenttable-blue" width="100%"
|-
! style="width:300px;" |Service
!required for
|-
||NodeJS/Parsoid
||VisualEditor
|-
|NodeJS/PhantomJS
|generating screenshots (e.g. recent changes)
|-
|Java Application Server (Jetty)/ Tomcat
|PDF export
|-
|Java Application Server (Jetty)/ VisualDiff
|compare versions of a page
|-
|Java Application Server (Jetty)/ TeX
|math formulas
|-
|Search Server (ElasticSearch)
|search
|-
|SVG-Renderer (Inkscape)
|.svg
|-
|Python/Pygmentize
|syntax highlighting source code in pages
|}
====Scheme Docker Container====
<bs:drawio filename="YourCompany/Documentation-57586720" /><bs:drawio filename="Structure of the docker container" />
<bs:universalexport:pagebreak />
 
==Production Wiki==
{{:YourCompany/Production_System}}<b
==Development Wiki==
{{:YourCompany/Development_System}}<b
==Authentication and Security Levels==
===SAML/Prod===
The following domains are all connected to SAML:
 
*[https://wiki.yourcompany.com/w/index.php/Special:SimpleFarmer wiki.yourcompany.com] = Main Instance = WikiFarm Management
*[https://wiki.yourcompany.com/yourcompany wiki.yourcompany.com] redirects to wiki.yourcompany.com/yourcompany= YourCompany Wiki
*wikidocs.yourcompany.com redirects to wiki.yourcompany.com/yourcompany with local login
 
<br>
===Security levels of wikis===
<nowiki>*</nowiki> = (all) = applies to every visitor of the wiki, including those who do not log in.
 
====Public====
{| class="wikitable" width="100%"
! colspan="2" |
! colspan="4" |permissions
|-
!user group
!login required
!sys admin
!wiki maintain admin
!editor
!reader
|-
|[...]_Admin
|x
|x
|x
|x
|x
|-
|*
| ---
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|x
|x
|}
 
====Protected====
{| class="wikitable" width="100%"
! colspan="2" |
! colspan="4" |permissions
|-
|-
!user group
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |It ensures that the product can be commissioned, used, maintained and, if necessary, disposed of safely and as intended.
!login required
The external documentation is usually created by technical editors and usually translated into the language of the respective user. Examples of external technical documentation:
!sys admin
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Sie dient der internen Archivierung aller produktrelevanten Dokumente und der Nachweispflicht, alle rechtlichen Pflichten eingehalten zu haben. Sie kann den gesamten Produktlebenszyklus von der Produktplanung über Entwicklung, Markteinführung und Produktbeobachtung bis zur Einstellung des Produkts umfassen. Typische Bestandteile eine internen Dokumentation sind:
!wiki maintain admin
!editor
!reader
|-
|-
|[...]_Admin
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |
|x
*Gebrauchs-/ Betriebs-/ Bedienungsanleitung,
|x
*Installations- und Montageanleitung,
|x
*Serviceanleitungen, Wartungs- und Reparaturanleitung,
|x
*Software-Handbücher, Benutzerhandbuch und Online-Hilfe,
|x
*Projektdokumentationen,
|-
*Produktdokumentation und Datenblätter,
|[...]_Editeren
*Sicherheitsanweisungen / Arbeitssicherheit,
|x
*Produktvideos, Tutorial usw.
| ---
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |
| ---
*Instructions for use / operating / operating instructions,
|x
*installation and assembly instructions,
|x
*Service instructions, maintenance and repair instructions,
|-
*software manuals, user guide and online help,
|*
*project documentation,
| ---
*product documentation and data sheets,
|<nowiki>---</nowiki>
*safety instructions / occupational safety,
|<nowiki>---</nowiki>
*Product videos, tutorial, etc.
| ---
|x
|}
|}
You can get a first impression at the following pages:


====Private====
*[https://en.demo.bluespice.com/wiki/Electric_Pallet_Truck_Alligator Electric_Pallet_Truck_Alligator]
{| class="wikitable" width="100%"
*[https://en.demo.bluespice.com/wiki/Caustic_Soda Caustic_Soda]
! colspan="2" |
*[https://en.demo.bluespice.com/wiki/Coffeemaker Coffeemaker]
! colspan="4" |permissions
*[https://en.demo.bluespice.com/wiki/Category:Bike Categorized product pictures]
|-
!user group
!login required
!sys admin
!wiki maintain admin
!editor
!reader
|-
|[...]_Admin
|x
|x
|x
|x
|x
|-
|[...]_Editeren
|x
| ---
| ---
|x
|x
|-
|[...]_Lezen
|x
| ---
| ---
| ---
|x
|-
|*
| ---
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
| ---
| ---
|}
 
====Admin====
{| class="wikitable" width="100%"
! colspan="2" |
! colspan="4" |permissions
|-
!user group
!login required
!sys admin
!wiki maintain admin
!editor
!reader
|-
|[...]_Admin
|x
|x
|x
|x
|x
|-
|*
| ---
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
| ---
| ---
|}
<br>
===URL===
If the URL of a wiki does not exist (or there is a letter error because of case-sensitivity), the user is currently redirected to the farm management. Depending on the authorization level, the user might not have access. It is possible to redirect the user to a page of another instance. However, this can only be done '''once'''. Redirects always link to the same instance. On the target page you could, for example, store an overview of operating wikis.

Latest revision as of 10:06, 3 May 2022

BlueSpice is the platform for technical documentation.

Wiki as a tool for technical documentation
External technical documentation Interne Technische Dokumentation
It ensures that the product can be commissioned, used, maintained and, if necessary, disposed of safely and as intended.

The external documentation is usually created by technical editors and usually translated into the language of the respective user. Examples of external technical documentation:

Sie dient der internen Archivierung aller produktrelevanten Dokumente und der Nachweispflicht, alle rechtlichen Pflichten eingehalten zu haben. Sie kann den gesamten Produktlebenszyklus von der Produktplanung über Entwicklung, Markteinführung und Produktbeobachtung bis zur Einstellung des Produkts umfassen. Typische Bestandteile eine internen Dokumentation sind:
  • Gebrauchs-/ Betriebs-/ Bedienungsanleitung,
  • Installations- und Montageanleitung,
  • Serviceanleitungen, Wartungs- und Reparaturanleitung,
  • Software-Handbücher, Benutzerhandbuch und Online-Hilfe,
  • Projektdokumentationen,
  • Produktdokumentation und Datenblätter,
  • Sicherheitsanweisungen / Arbeitssicherheit,
  • Produktvideos, Tutorial usw.
  • Instructions for use / operating / operating instructions,
  • installation and assembly instructions,
  • Service instructions, maintenance and repair instructions,
  • software manuals, user guide and online help,
  • project documentation,
  • product documentation and data sheets,
  • safety instructions / occupational safety,
  • Product videos, tutorial, etc.

You can get a first impression at the following pages:

Retrieved from "https://en.demo.bluespice.com/w/index.php?title=YourCompany/Documentation&oldid=1335"
No categories assignedEdit

Discussions