On Friday, October 30, 2015 at 9:01:09 AM UTC-4, Lex Trotman wrote:
>
>
> But as the second asciidoctor ticket you referred to seems to be
> coming to the conclusion, attributing and tracking changes is the job
> that VCS systems are specialised for.
>
>
I agree a 100% on that one. The asciidoc/git combo is so powerful that I
don't feel like a new markup extension is required to do what CriticMarkup
achieves. All you need is a protocol for your team.
We released several papers using git and asciidoc and the writing and
review process was done in small teams. Here is what I wrote to the team
regarding reviews:
---->8-----
== Fixes
Typos and obviously bad wording should be fixed inplace. One can word-diff
with
git to review what someone else fixed even if there would be white space
issues.
git diff --word-diff
== Comments or suggestions
To leverage the asciidoc markup language do your comments with lines
starting
with //.
For example:
...
operation are usually able to remove other malware components such as
Linux/Cdorked, but often overlook the OpenSSH backdoor due to the
stealthiness
// ^ sure
about this word?
// I don't
like it [OB]
mechanisms used. Thus, it was common for the operators to come back a few
days
later and revert the changes made by the administrator.
// [OB] thinking about it, why don't you remove this whole paragraph?
Longer comments can be made using the block comment markup: ////
== Review branches
Reviews can be done inside branches where all suggestions are committed and
then the text reworded by the integrator as he accepts or rejects changes
and
modify text according to comments. Then a squash merge of the review branch
can be done in master branch in order to keep the history tidy.
---->8-----
It worked great for us so far.
--
You received this message because you are subscribed to the Google Groups
"asciidoc" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/asciidoc.
For more options, visit https://groups.google.com/d/optout.
