- Die Dokumentation wird kuratiert und moderiert, nicht alles kann und wird einfließen.
- Pull Requests bitte nicht nur skizzieren, sondern vervollständigen.
- keep it simple and short stupid, wait KIS ASS? (KISS)
- Bitte in Markdown
- Bitte keine Beschreibungen und Anleitungen von Programmen wenn diese bereits vom jeweiligen Projekt gut dokumentiert wurden. Dinge ändern sich schnell, bitte auch hin und wieder die Links prüfen.
- Keine Links zu kommerziellen Webseiten wie beispielsweise Heise, CT o.ä. (Es scheint wird dieses Projekt als Konkurrenz gesehen. Verständlich, da ich üblicherweise kostenpflichtige Anleitung teilweise kostenlos anbiete)
- Nutzungsbeispiele für das Skript
- Best Practises - Vorgehensweisen bei bestimmten Anforderungen und Problemen
- Beispiele die in Programm Docs fehlen
- Vorschläge übersichtliche Dokumentationstruktur
Die aktuelle Struktur findet sich in der mkdocs.yml der jeweiligen Dokumentation
- The documentation is curated and moderated; not everything can or will be included.
- Please create pull requests not only as outlines but in complete form.
- Keep it simple and short, stupid. Wait, KIS ASS? (KISS)
- Please use Markdown.
- Avoid descriptions and instructions for programs that already have official documentation. If possible, provide appropriate links and keep them up to date.
- No links to commercial websites such as Heise, CT, etc. (It seems this project is perceived as competitor. Understandable, as I usually offer partially paid instructions for free.)
- Usecases for the script.
- Best practices - approaches to specific requirements and issues.
- Examples missing in program docs.
- Suggestions for an organized documentation structure.
The current structure can be found in the mkdocs.yml of the respective documentation.