View Issue Details

IDProjectCategoryView StatusLast Update
0000041Dokumentation // Documentation[Adventure PHP Framework] Dokumentation // Documentationpublic2017-09-08 15:23
ReporterChristianAchatzAssigned Todave 
PrioritynormalSeveritytweakReproducibilityalways
Status assignedResolutionopen 
Product Version[Adventure PHP Framework] 2.0 
Target Version[Adventure PHP Framework] 4.0Fixed in Version 
Summary0000041: Docu/HowTo missing that describes how changes to the documentation have to be applied
DescriptionAs noted under http://tracker.adventure-php-framework.org/view.php?id=32#c25 there is currently no documentation that describes how changes to the documentation should be applied (e.g. which files to change).

Within this issue a HowTo should be created to clarify this topic and to build a basis for communication for new developers.
TagsNo tags attached.
Codereferenz: ([Datei]:[Zeile])
Namespacenone

Activities

dave

2013-11-20 20:09

developer   ~0000081

Würde mich der Sache annehmen. Gibt's denn Wünsche, was unbedingt genannt werden muss? Hat sich denn gegenüber 1.xx irgendwas geändert (dafür habe ich ja schon ein paar Dokus erstellt)?

ChristianAchatz

2013-11-20 23:06

administrator   ~0000085

@dave: nein, die Struktur ist gleich geblieben. Einzige größere Änderung ist, dass die HTML-Dateien nun eine Versions-Kennung (z.B. "2.X" oder "1.X") haben. Ist eine Dokumentation lediglich in "2.X" verfügbar, bitte diese zuerst nach "1.X" kopieren und anschließend die "2.X" ändern und einchechen.

Bei Fragen immer gerne! :)

ChristianAchatz

2013-11-28 19:18

administrator   ~0000111

Last edited: 2013-11-28 19:21

View 2 revisions

Hier mein Feedback:

1) c_de_155_1.X_*.html braucht es nur, wenn du für den Zweig 1.X des APF und 2.X eine unterschiedliche Doku hast. Falls gleich,
einfach nur ein c_de_155_2.X_*.html anlegen. Das gilt dann für beide Versionen. Selbiges gilt für die n_de_155_*.html-Dateien.

2) In Code-Beispielen, die APF-Tags enthalten, die im lokalen Gültigkeitsbereich bekannt sind, müssen maskiert werden.
Beispiel:

Don't:
< gen:highlight type="apf-xml" >
< doku:title parent="071" tags="..." title="." urlname="." >
   ...
< / doku:title >
< / gen:highlight >

Do:

< gen:highlight type="apf-xml" >
< doku:title parent="071" tags="..." title="." urlname="." >
   ...
< / doku:title >
< / gen:highlight >

3) Hervorhebungen nicht per "..." sondern per < em >...< / em >

4) Titel etwas kürzer fassen, vielleicht: Erstellen der offiziellen Dokumentation

5) [quote]Ich bin HTML-Code oder APF-XML-Code [..][/quote]
Bitte ausserhalb des Demo-Code-Blocks platzieren, da innerhalb recht schlecht zu lesen.

6) Am Ende bitte

[code]< core:importdesign namespace="APF\modules\comments\pres\templates" template="comment" categorykey="de_154" / >[/code]

einbauen.

7) Kapitel 2.2: Schema sollte etwas genauer aufgezeigt werden: "c" oder "n", "1.X" oder "2.X". Für neue Inhalte ab 2.0
oder Kapitel bei denen keine Unterscheidung zwischen <=1.17 und >=2.0 notwendig ist immer "2.X".

- Für die Doku sollte es Abnahme-Kriterien geben. Z.B.:
- Englisch und Deutsche Version vorhanden
- Feature-Beschreibungen beinhalten alle Funktionalitäten inkl. Anwendungsbeispiele
- Framework-Funktions-Beschreibungen beinhalten Konzept, Anwendung und Erweiterung
- Sofern innerhalb eines Zweigs (1.X, 2.X) Unterschiede in der Verwendung besteht, muss dies als Hinweis vermerkt sein.
- Tags müssen mit der vollständigen Liste von Attributen dokumentiert sein.
- ...

8) Fehlende Inhalte sind noch:
- Wo kategorisieren sich Inhalte ein (Tutorial, Dokumentation, Artikel)?
- Ordner-Struktur der Doku-Seite
- Wie setze ich die Seite lokal auf um sie zu testen? --> wichtig insbesondere bei der 155er Seite, da diese in der ersten
  Fassung Fehler hatte.
- Einbau Kommentarfunktion so oft als möglich
- Wie/wo baue ich Grafiken ein? Vorlagen finde ich wo?
- Wie sieht die HTML-Struktur aus? --> Texte in sinnvolle Sektionen mit < p / >-Tags gliedern. Listen und Code-Beispiele ausserhalb von < p / >-Tags...

ChristianAchatz

2014-01-25 18:35

administrator   ~0000184

Last edited: 2014-01-25 18:35

View 2 revisions

Auf 2.1 verschoben um 2.0 nicht zu verzögern.

ChristianAchatz

2015-03-18 13:23

administrator   ~0000559

Auf 3.1 verschoben.

ChristianAchatz

2016-02-13 13:38

administrator   ~0000664

Moved to 3.2 to close 3.1 (3.1 already delayed).

Issue History

Date Modified Username Field Change
2013-06-04 22:39 ChristianAchatz New Issue
2013-07-16 19:01 jwlighting Category Dokumentation => Dokumentation // Documentation
2013-11-20 20:09 dave Note Added: 0000081
2013-11-20 20:34 jwlighting Assigned To => dave
2013-11-20 20:34 jwlighting Status new => assigned
2013-11-20 23:06 ChristianAchatz Note Added: 0000085
2013-11-28 19:18 ChristianAchatz Note Added: 0000111
2013-11-28 19:21 ChristianAchatz Note Edited: 0000111 View Revisions
2014-01-25 18:34 ChristianAchatz Target Version 2.0 => 2.1
2014-01-25 18:35 ChristianAchatz Note Added: 0000184
2014-01-25 18:35 ChristianAchatz Note Edited: 0000184 View Revisions
2014-05-28 07:52 ChristianAchatz Target Version 2.1 => 3.0
2015-03-18 13:23 ChristianAchatz Note Added: 0000559
2015-03-18 13:23 ChristianAchatz Target Version 3.0 => 3.1
2016-02-13 13:38 ChristianAchatz Note Added: 0000664
2016-02-13 13:38 ChristianAchatz Target Version 3.1 => 3.2
2016-03-23 14:01 ChristianAchatz Target Version 3.2 => 3.3
2017-03-18 18:49 ChristianAchatz Target Version 3.3 => 3.4
2017-09-08 15:23 ChristianAchatz Target Version 3.4 => 4.0