Versions Compared

Old Version 2

changes.mady.by.user GE-DevDoc-Bot

Saved on

compared with

New Version 3

changes.mady.by.user GE-DevDoc-Bot

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Sentences should be short and use easy language.
  2. Repetition of information should be avoided. A detailed description should exist only once and further mentions should be short and relevant to the situation.
  3. A listing of information during a paragraph should use bullet points instead of text.
  4. Information should always be accompanied by a picture visualizing the information.
  5. An Image should be labeled if they give information that is not described in the text accompanying it.

Tags, Notes, other Accessories

The Documentation has 4 types of tags: draft, new, old, updated.

Draft

A page with this tag has content that is actively in development or unfinished. Therefor the published arcticle is currently unfinished. Following szenarios might apply:

  • The item of the page, for example a component, is currently in its initial development.
  • Information in an article, for example a pattern, is being reworked and thereby subject to change.
  • A page in the wiki is being created and the published version is not the desired final state.

A note at the beginning of an article can explain what the development in question is referring to.

New

After a pages first creation it recieves the tag "new". This tag vanishes after two months of being present.

Updated

After recieving significant changes in the content, a page recieves the "updated" tag. This tag vanishes after one month. Significent pages include but are not limited to:

  • Addition - New information is added to the page. For example, a component has a new feature.
  • Deletion - Outdated or wrong information gets removed from a page.
  • Alteration - Information on the page is fundamentally changed. For example, a pattern is restructured. This does not include purely editorial changes.

Coution

If a page contains critical content, it recieves the "Caution"-tag. This applies to both the text and the information behind it. Examples for critical information:

  • A page shows outdated information that might mislead the user.
  • The subject of the page, for example a component, is not working as designed and needs to be changed.
  • Infomration on a page is not verified.
  • Multiple users have reported problems with this page.