Herbert Breunung avatar Herbert Breunung committed 383be93

completing documentation chapter

Comments (0)

Files changed (1)

doc/CompleteProgramming.pod

 about one thing. Meetings get more productive too when arguing has a common basis.
 
 User docs, developer docs and comments, as well as the code itslef are means of
-communication between people. They have to therefore cooperate seamlessly.
+communication between people. They have to cooperate seamlessly.
 All these parts should have a common language and define key words and phrases
-in the exactly same way. Less friction here is an enormous productivity boost.
-A further reason, why they gotta be written altogether and by the same people.
+in the exactly same way. Less friction here is an enormous productivity boost -
+a further reason, why they gotta be written altogether and by the same people.
+
+Things not always turn out as planned. So quite often the docs have to be adjusted
+after the implementation of a feature. That oughta be done anyway, because the
+first phase docs were just sketchy drafts, stating what you could know then,
+which always becomes more after the coding. Small iterations between these states
+amplify an holistic understanding and overall quality. The exact rules how to
+iterate are part of the chapter L<Itersations>.
 
 
 
 its after thought
 
 
+=head3 Itersations
+
 =head3 Releases
 
 see more in L<lib/Kephra/Versioning.pod>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.