Difference between revisions of "Wiki Technical Guide"

From EncyclopAtys

Jump to: navigation, search
m
m
Line 14: Line 14:
 
===Talk pages===
 
===Talk pages===
 
It is often useful, convenient or necessary to leave a message to someone else. For that purpose a “Talk” page is associated with each document when it is created, for example here: [[Talk:{{FULLPAGENAME}}]] '''<code><nowiki>[[Talk:{{FULLPAGENAME}}]]</nowiki></code>'''.
 
It is often useful, convenient or necessary to leave a message to someone else. For that purpose a “Talk” page is associated with each document when it is created, for example here: [[Talk:{{FULLPAGENAME}}]] '''<code><nowiki>[[Talk:{{FULLPAGENAME}}]]</nowiki></code>'''.
 +
 +
In any case, you must try to maintain something readable, so each topic will start with a title '''<code><nowiki>===Title of the topic==</nowiki></code>'''. It is better to have fifty small separate subjects, each with a title, than a single package of fifty subjects. This facilitates discriminated responses in their consideration, implementation, etc.
 +
 +
At the end of the subject, always sign with '''<code><nowiki>~~~~</nowiki></code>'''. This immediately lets anyone know who posted the message and when.
 +
 +
Usually, responses are made by indenting as in emails. This is done by opening the line with one more <code>:<code> than the previous part. Obviously each answer, each rebound will be signed. This is very useful for someone who will ask the same questions later on and who will thus see this discussion as part of a “Knowledge Base”.
 +
 +
Last, it may be useful to attach to the title a '''{{OK}}''' to indicate that the subject is closed '''<code><nowiki>==Title of the topic {{{OK}}==</nowiki></code>'''. If the subject has to be reopened, the '''{{OK}}''' can be replaced by a '''{{KO}}''' '''<code><nowiki>{{{KO}}</nowiki></code>'''.

Revision as of 22:32, 8 June 2019


Important.png
Under Construction Panel.png !!!! WIP !!!! Under Construction Panel.png
There are currently still 74 articles in preparation in the category "WIP"
Article in preparation. Please let the author finish it before you modify it.
The last editing was from Maupas on 8.06.2019.

Maupas (talk) 22:36, 8 June 2019 (CEST)
de:Technischer Wiki-Leitfaden
en:Wiki Technical Guide
es:Guía Técnica de la Wiki
fr:Guide Technique du wiki
ru:Техническое руководство по Вики
 
UnderConstruction.png
Translation to review
Don't blame the contributors, but come and help them 😎

Reference text ( Maintained text, used as reference ) :
Notes: (Maupas, 2019-06-08)

A short technical guide for experienced contributors and documentation managers.

Working as a team

Never forget that any document (except protected pages, accessible only to administrators) can be edited at any time by anyone. See below (Edition puis Content Validation) for good practices to be followed.

Talk pages

It is often useful, convenient or necessary to leave a message to someone else. For that purpose a “Talk” page is associated with each document when it is created, for example here: Talk:Wiki Technical Guide [[Talk:{{FULLPAGENAME}}]].

In any case, you must try to maintain something readable, so each topic will start with a title ===Title of the topic==. It is better to have fifty small separate subjects, each with a title, than a single package of fifty subjects. This facilitates discriminated responses in their consideration, implementation, etc.

At the end of the subject, always sign with ~~~~. This immediately lets anyone know who posted the message and when.

Usually, responses are made by indenting as in emails. This is done by opening the line with one more :<code> than the previous part. Obviously each answer, each rebound will be signed. This is very useful for someone who will ask the same questions later on and who will thus see this discussion as part of a “Knowledge Base”.

Last, it may be useful to attach to the title a to indicate that the subject is closed <code>==Title of the topic {{{OK}}==. If the subject has to be reopened, the can be replaced by a {{{KO}}.