Revision history for WelcomeDocumenter
Revision [22748]
Last edited on 2016-05-20 07:38:42 by DarTar [Replaces old-style internal links with new pipe-split links.]Additions:
This page can now be found on the [[Docs:WelcomeDocumenter | Wikka Documentation Server]].
An archive of [[http://wikkawiki.org/WelcomeDocumenter/revisions | old revisions of this page]] is still available for reference.<<
An archive of [[http://wikkawiki.org/WelcomeDocumenter/revisions | old revisions of this page]] is still available for reference.<<
Deletions:
An archive of [[http://wikkawiki.org/WelcomeDocumenter/revisions
old revisions of this page]] is still available for reference.<<
Additions:
<<===This page has moved===
This page can now be found on the [[Docs:WelcomeDocumenter Wikka Documentation Server]].
Thanks for updating your bookmarks!
----
An archive of [[http://wikkawiki.org/WelcomeDocumenter/revisions
old revisions of this page]] is still available for reference.<<
::c::
----
CategoryMigratedDocs
This page can now be found on the [[Docs:WelcomeDocumenter Wikka Documentation Server]].
Thanks for updating your bookmarks!
----
An archive of [[http://wikkawiki.org/WelcomeDocumenter/revisions
old revisions of this page]] is still available for reference.<<
::c::
----
CategoryMigratedDocs
Deletions:
WikkaWiki welcomes efforts to improve its official [[WikkaDocumentation documentation]].
This page contains all the necessary information for users willing to write documentation pages.
=== General documentation guidelines ===
To preserve the overall consistency of documentation pages, please respect the following guidelines when creating/editing a documentation page.
~-When creating a new documentation entry, [[WikkaDocumentation check first]] that another page on the same topic does not already exist. Redundant documentation can be confusing.
~-Use plain, understandable English and avoid using a technical lexicon, unless you are writing developer documentation.
~-Documentation code for the end user should not contain code blocks.
~-Documentation pages for features/actions included in [[WikkaReleaseNotes official releases]] should be linked from the [[WikkaDocumentation Wikka Documentation page]]
~-Each documentation page should be formatted following the template below:
~ ---
~%%
[[WikkaDocumentation Wikka Documentation]]
----
=====Title of the page =====
Here goes page content
...
...
...
...
----
CategoryDocumentation
%%
~-You can directly generate well-formatted documentation pages by "cloning" the [[http://wikka.jsnx.com/DocumentationTemplate/clone DocumentationTemplate]]
~-Do not create documentation entries for features/actions that are not yet included in the [[WikkaReleaseNotes official Wikka releases]]
~-When writing documentation pages, try to add links to keywords whenever the text allows it. For instance, when referring to the release notes you should add a link to WikkaReleaseNotes like ##""[[WikkaReleaseNotes official releases]]""##.
----
CategoryWelcome
Additions:
=====Title of the page =====
Deletions:
Additions:
~-When creating a new documentation entry, [[WikkaDocumentation check first]] that another page on the same topic does not already exist. Redundant documentation can be confusing.
Deletions:
Additions:
=== General documentation guidelines ===
To preserve the overall consistency of documentation pages, please respect the following guidelines when creating/editing a documentation page.
~-When creating a new documentation entry, [[WikkaDocumentation]] check first that another page on the same topic does not already exist. Redundant documentation can be confusing.
~-Use plain, understandable English and avoid using a technical lexicon, unless you are writing developer documentation.
~-Documentation code for the end user should not contain code blocks.
~-Documentation pages for features/actions included in [[WikkaReleaseNotes official releases]] should be linked from the [[WikkaDocumentation Wikka Documentation page]]
~-Each documentation page should be formatted following the template below:
~ ---
~%%
[[WikkaDocumentation Wikka Documentation]]
====Title of the page ====
Here goes page content
...
...
...
...
CategoryDocumentation
%%
~-You can directly generate well-formatted documentation pages by "cloning" the [[http://wikka.jsnx.com/DocumentationTemplate/clone DocumentationTemplate]]
~-Do not create documentation entries for features/actions that are not yet included in the [[WikkaReleaseNotes official Wikka releases]]
~-When writing documentation pages, try to add links to keywords whenever the text allows it. For instance, when referring to the release notes you should add a link to WikkaReleaseNotes like ##""[[WikkaReleaseNotes official releases]]""##.
To preserve the overall consistency of documentation pages, please respect the following guidelines when creating/editing a documentation page.
~-When creating a new documentation entry, [[WikkaDocumentation]] check first that another page on the same topic does not already exist. Redundant documentation can be confusing.
~-Use plain, understandable English and avoid using a technical lexicon, unless you are writing developer documentation.
~-Documentation code for the end user should not contain code blocks.
~-Documentation pages for features/actions included in [[WikkaReleaseNotes official releases]] should be linked from the [[WikkaDocumentation Wikka Documentation page]]
~-Each documentation page should be formatted following the template below:
~ ---
~%%
[[WikkaDocumentation Wikka Documentation]]
====Title of the page ====
Here goes page content
...
...
...
...
CategoryDocumentation
%%
~-You can directly generate well-formatted documentation pages by "cloning" the [[http://wikka.jsnx.com/DocumentationTemplate/clone DocumentationTemplate]]
~-Do not create documentation entries for features/actions that are not yet included in the [[WikkaReleaseNotes official Wikka releases]]
~-When writing documentation pages, try to add links to keywords whenever the text allows it. For instance, when referring to the release notes you should add a link to WikkaReleaseNotes like ##""[[WikkaReleaseNotes official releases]]""##.
Additions:
=====Guidelines for documentation contributors=====
WikkaWiki welcomes efforts to improve its official [[WikkaDocumentation documentation]].
This page contains all the necessary information for users willing to write documentation pages.
WikkaWiki welcomes efforts to improve its official [[WikkaDocumentation documentation]].
This page contains all the necessary information for users willing to write documentation pages.
Deletions:
WikkaWiki welcomes code modifications and extensions from new developers.
This page contains all the necessary information for users willing to contribute code.
