SlideShare ist ein Scribd-Unternehmen logo
DOCUMENTATION
Sybille Peters
sybille.peters@typo3.org
@T3DocTeam
@sypets
TYPO3 Camp Berlin 2019
#t3cb
1. Das Team
2. Wer schreibt Doku?
3. Was ist TYPO3
Doku?
4. Wie ist sie
aufgebaut?
5. Contributen - Wer,
wie, was, warum?
AGENDA
25.06.2019 2Sybille Peters
DAS TEAM
3
DOCUMENTATION TEAM
 Martin Bless
 Daniel Siepmann
 Sybille Peters
4
25.06.2019 Sybille Peters
https://typo3.org/community/teams
/documentation
DAS TEAM: KONTAKT
 Slack: #typo3-documentation
 Twitter: @T3DocTeam
 (Email: documentation@typo3.org)
5
25.06.2019 Sybille Peters
https://typo3.org/community/teams
/documentation
DAS TEAM: AUFGABEN (1)
 Technische Infrastruktur:
– Docker Image
– Theme
– ...
6
25.06.2019 Sybille Peters
DAS TEAM: AUFGABEN (2)
 Doku über Doku schreiben
 Pull requests mergen
 Support: Slack channel #typo3-
documentation
 Kommunikation: news, Twitter
 Slack calls, Sprints
7
25.06.2019 Sybille Peters
WER SCHREIBT
DOKU?
8
?
9
TYPO3
COMMUNITY!
10
WER SCHREIBT DOKU?
11
25.06.2019 Sybille Peters
WER SCHREIBT DOKU?
Früher:
 Doku Team
Heute:
 Core Contributor: Changelog
 Core Team updatet TYPO3 Explained, Referenzen etc.
 Community …
Alle können etwas beitragen!
12
25.06.2019 Sybille Peters
WAS IST TYPO3
DOKUMENTATION?
13
WAS IST TYPO3 DOKUMENTATION?
 Alles auf https://docs.typo3.org
 Offizielle Doku / community Doku
14
WAS IST TYPO3 DOKUMENTATION?
Offizielle Doku:
 Tutorials
 Guides
 References
 Changelog
 System Extension
Doku
 ...
15
WAS IST TYPO3 DOKUMENTATION?
Community Doku:
 Third Party
Extension
Dokumentation
16
WAS IST TYPO3 DOKUMENTATION?
 Einheitliches Format:
reStructuredText
 Einheitliche Struktur
 Automatisches Rendering (Webhook,
Intercept)
 Einheitliches Layout
17
TYPO3 DOKU
IST OPEN
SOURCE!
18
WIE IST TYPO3
DOKU
AUFGEBAUT?
19
WIE IST TYPO3 DOKU AUFGEBAUT?
 1x Homepage („glue pages)
 Handbücher (Tutorials, Guides, etc.)
20
WIE IST TYPO3 DOKU AUFGEBAUT?
 1 Handbuch → 1 GitHub Repository
21
https://github.com/TYPO3-Documentationhttps://docs.typo3.org/m/typo3/reference-tca/master/en-us/
WIE IST TYPO3 DOKU AUFGEBAUT?
.
├── composer.json
└── Documentation
├── Index.rst
├── Settings.cfg
└── ...
22
WIE IST TYPO3 DOKU AUFGEBAUT?
23
 .rst : reStructuredText
 Text mit markup
 Texteditor, IDE
 ReStructuredText plugin PhpStorm
WIE IST TYPO3 DOKU AUFGEBAUT?
24
DocTitle
└── Topic 1
└── Subtopic 1.1
└── Subtopic 1.1.1
└── Topic 2
WIE IST TYPO3 DOKU AUFGEBAUT?
25
WIE IST TYPO3 DOKU AUFGEBAUT?
Mehr zu reStructuredText
 Writing Documentation
→ Common Pitfalls
→ Cheat Sheet
26
WIE IST TYPO3 DOKU AUFGEBAUT?
Was ist mit Markdown?
 Wird auch unterstützt
 Offizielle Doku: nur reST
 Writing Documentation
→ Conventions → Formats
27
https://docs.typo3.org/m/typo3/docs-how-t
o-document/master/en-us/GeneralConve
ntions/Format.html
WIE IST TYPO3 DOKU AUFGEBAUT?
Was ist mit Markdown?

28
https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/GeneralConventions/DirectoryFilenames.html
CONTRIBUTE
WARUM?
29
?
30
CONTRIBUTE – WARUM?
 Wie gut ist die Doku?
 Wie aktuell ist die Doku?
 Wie gut verständlich ist die Doku?
31
TYPO3
BRAUCHT
GUTE DOKU
32
CONTRIBUTE – WARUM?
Vorteile: Gute Dokumentation
 Weniger Zeit f. Einarbeitung
 Leichteres Onboarding f. Mitarbeiter
 Mehr TYPO3 Entwickler
 Weniger Frust
33
CONTRIBUTE – WARUM?
Vorteile: Contribution
 Bessere Doku für alle
 Lernen (git, reST, GitHub, Docker,
schreiben, erklären)
34
CONTRIBUTE – WARUM?
35
COMMUNITYCOMMUNITY
CONTRIBUTE
WAS?
36
?
37
CONTRIBUTE – WAS?
 Lesen!
 Feedback!
 Verbessern!
38
CONTRIBUTE – WAS?
Was ist besser?
 GitHub Issue schreiben?
 Oder Problem selbst lösen?
39
EIN BEHOBENES
PROBLEM IST
EINS WENIGER
40
CONTRIBUTE – WAS?
Feedback
 Fehler → Issue schreiben
 Slack Channel #typo3-
documentation
 Twitter: @T3DocTeam
41
CONTRIBUTE – WAS?
GitHub Issues
 Zu jedem Handbuch gehören Issues
 Problem in einem Handbuch → Issues
zu dem Repo (Related Links)
42https://github.com/TYPO3-Documentation
CONTRIBUTE – WAS?
Allgemeine Probleme
 In Slack #typo3-documentation
melden
 In Team repo:
https://github.com/TYPO3-Document
ation/T3DocTeam/issues
43
CONTRIBUTE – WAS?
 Mehr Info: „Writing Documentation“
→ „How You Can Help“
44
CONTRIBUTE
EINFACH
ANFANGEN
45
CONTRIBUTE - EINSTIEGSPUNKTE
 TYPO3 Blog:
 Writing
Documentation:


46
DEMO ...
47
DANKE!
48

Weitere ähnliche Inhalte

Ähnlich wie TYPO3 Dokumenation (#t3cb 2019 - German)

Podcasts und Videocasts fuer Bibliotheken
Podcasts und Videocasts fuer BibliothekenPodcasts und Videocasts fuer Bibliotheken
Podcasts und Videocasts fuer Bibliotheken
Luka Peters
 
FLOW3 Einführung auf dem TYPO3Camp Berlin 2012
FLOW3 Einführung auf dem TYPO3Camp Berlin 2012FLOW3 Einführung auf dem TYPO3Camp Berlin 2012
FLOW3 Einführung auf dem TYPO3Camp Berlin 2012Christof Rodejohann
 
TYPO3 Certified Integrator - Teste dein Wissen
TYPO3 Certified Integrator - Teste dein WissenTYPO3 Certified Integrator - Teste dein Wissen
TYPO3 Certified Integrator - Teste dein Wissen
Alex Kellner
 
Neues aus der TYPO3-Welt: 03/2018
Neues aus der TYPO3-Welt: 03/2018Neues aus der TYPO3-Welt: 03/2018
Neues aus der TYPO3-Welt: 03/2018
Kai Unterberg
 
Eine Website in einer Stunde mit TYPO3 bauen
Eine Website in einer Stunde mit TYPO3 bauenEine Website in einer Stunde mit TYPO3 bauen
Eine Website in einer Stunde mit TYPO3 bauen
DeveloperConference
 
Eine Website in einer Stunde mit TYPO3 bauen, Gernot Ploiner
Eine Website in einer Stunde mit TYPO3 bauen, Gernot PloinerEine Website in einer Stunde mit TYPO3 bauen, Gernot Ploiner
Eine Website in einer Stunde mit TYPO3 bauen, Gernot PloinerDeveloperConference
 
Onno Reiners: E-Learning einfach selbst erstellen
Onno Reiners: E-Learning einfach selbst erstellenOnno Reiners: E-Learning einfach selbst erstellen
Onno Reiners: E-Learning einfach selbst erstellen
lernet
 
Web20 Lernumgebung
Web20 LernumgebungWeb20 Lernumgebung
Web20 Lernumgebungjoqel
 
TYPO3 Neos in der Praxis
TYPO3 Neos in der PraxisTYPO3 Neos in der Praxis
TYPO3 Neos in der Praxis
TechDivision GmbH
 
Git & Gerrit: Verteilte Softwareentwicklung und -reviews in der TYPO3-Community
Git & Gerrit: Verteilte Softwareentwicklung und -reviews in der TYPO3-CommunityGit & Gerrit: Verteilte Softwareentwicklung und -reviews in der TYPO3-Community
Git & Gerrit: Verteilte Softwareentwicklung und -reviews in der TYPO3-CommunitySteffen Gebert
 
TYPO3 Neos - ein technischer Überblick - DWX 2013
TYPO3 Neos - ein technischer Überblick - DWX 2013TYPO3 Neos - ein technischer Überblick - DWX 2013
TYPO3 Neos - ein technischer Überblick - DWX 2013die.agilen GmbH
 

Ähnlich wie TYPO3 Dokumenation (#t3cb 2019 - German) (12)

Podcasts und Videocasts fuer Bibliotheken
Podcasts und Videocasts fuer BibliothekenPodcasts und Videocasts fuer Bibliotheken
Podcasts und Videocasts fuer Bibliotheken
 
FLOW3 Einführung auf dem TYPO3Camp Berlin 2012
FLOW3 Einführung auf dem TYPO3Camp Berlin 2012FLOW3 Einführung auf dem TYPO3Camp Berlin 2012
FLOW3 Einführung auf dem TYPO3Camp Berlin 2012
 
TYPO3 Certified Integrator - Teste dein Wissen
TYPO3 Certified Integrator - Teste dein WissenTYPO3 Certified Integrator - Teste dein Wissen
TYPO3 Certified Integrator - Teste dein Wissen
 
Neues aus der TYPO3-Welt: 03/2018
Neues aus der TYPO3-Welt: 03/2018Neues aus der TYPO3-Welt: 03/2018
Neues aus der TYPO3-Welt: 03/2018
 
Eine Website in einer Stunde mit TYPO3 bauen
Eine Website in einer Stunde mit TYPO3 bauenEine Website in einer Stunde mit TYPO3 bauen
Eine Website in einer Stunde mit TYPO3 bauen
 
Eine Website in einer Stunde mit TYPO3 bauen, Gernot Ploiner
Eine Website in einer Stunde mit TYPO3 bauen, Gernot PloinerEine Website in einer Stunde mit TYPO3 bauen, Gernot Ploiner
Eine Website in einer Stunde mit TYPO3 bauen, Gernot Ploiner
 
Onno Reiners: E-Learning einfach selbst erstellen
Onno Reiners: E-Learning einfach selbst erstellenOnno Reiners: E-Learning einfach selbst erstellen
Onno Reiners: E-Learning einfach selbst erstellen
 
Web20 Lernumgebung
Web20 LernumgebungWeb20 Lernumgebung
Web20 Lernumgebung
 
TYPO3 Neos in der Praxis
TYPO3 Neos in der PraxisTYPO3 Neos in der Praxis
TYPO3 Neos in der Praxis
 
Git & Gerrit: Verteilte Softwareentwicklung und -reviews in der TYPO3-Community
Git & Gerrit: Verteilte Softwareentwicklung und -reviews in der TYPO3-CommunityGit & Gerrit: Verteilte Softwareentwicklung und -reviews in der TYPO3-Community
Git & Gerrit: Verteilte Softwareentwicklung und -reviews in der TYPO3-Community
 
TYPO3 Neos - ein technischer Überblick - DWX 2013
TYPO3 Neos - ein technischer Überblick - DWX 2013TYPO3 Neos - ein technischer Überblick - DWX 2013
TYPO3 Neos - ein technischer Überblick - DWX 2013
 
Vögb unterlage
Vögb unterlageVögb unterlage
Vögb unterlage
 

TYPO3 Dokumenation (#t3cb 2019 - German)