Hi All
In the last coupe of meetings of the Documentation Team, we raised the
issue on changing the book writing / udating procedure and tools used.
Please join the discussion and share your opinions on the suggestions below.
Discussion: Time release of books (Dave, Olivier), (Drew, Olivier)
Rationale: Book authoring process
+ "perfect is enemy of the good" (Dave)
+ "better something than nothing" (olivier)
+ Software release way to fast for book editing
release/resources
+ gaps widens (olivier)
+ Revision of the revision of the revision does not work
+ very unproductive and not fun at all
+ but you need at least one revision (Drew)
Proposal
+ Set a date for publication (olivier)
+ deliver what is available (olivier)
+ Must have a minimum of quality (Drew)
+ update timely with corrections/erratas (olivier)
Process
+ Book assembly easier with master document (olivier)
+ changes in chapters sent automatically to master
+ Use of NextCloud + LOOL will improve file access and update
+ still need control on who is working on each file (Dave)
+ Current LO track changes very hard to read
+ sometimes too fragmented or granular (olivier)
+ Leave revision to time based erratas
+ Monthly or bi-monthly, or 1 errata per book release.
+ not connected to minor releases of the software (no
feature changes)
+ Published 6.n is draft 6.n+1
+ bring discussion to Doc ML.
Authoring
+ better have highly skilled authors we trust to cut revision
cycle (olivier)
+ No, newcomers are welcome (Drew)
+ size of project is intimidating (Drew)
+ then one revisor is needed (olivier)
+ periodic (once a week), approve changes.
Testing (Drew, Olivier)
+ We tested editing in the draft folder of 6.1 on NextCloud and LOOL
+ user can enable track change and approve his own changes.
+ attention issue.
+ keep backup
+ can't prevent user to replace file
+ attention issue
+ Communicate work in Mailing list
+ Keep gap between book and software features narrow to avoid
big chunk of editing
+ Use comments for remarks, tasks, in chapter contents contents
Misc
+ LOOL cannot handle master documents, do it offline
+ LOOL "Revision History" not clearly effective in our short session.
+ need further testing