bell notificationshomepageloginNewPostedit profile

Topic : Web-based WYSIWYG Markdown editor with commenting? My question is similar to this one, but with (hopefully) a clearly defined use case: sharing and reviewing basic tech docs with a minimal, intuitive - selfpublishingguru.com

10.04% popularity

My question is similar to this one, but with (hopefully) a clearly defined use case: sharing and reviewing basic tech docs with a minimal, intuitive GUI.

I'm producing technical documents using MS Word. These docs need to be reviewed, commented and have minimal additions & changes to their content, e.g. text, headings, tables.

I want to both
1. Track the changes
2. Accept/reject per change

In between focussing on getting the content right, a lot of issues come up (too many to list) around formatting, versioning, application compatibility etc.

It would be great if I could sidestep these and just

maintain a single source in Markdown while
providing a WYSIWYG "user interface" that only allows minimal interactions, i.e.:

changing/adding/deleting text/numbers/tables
commenting particular areas of text

In order to allow "users" to do these things without being in the Markdown workflow behind the scences, ideally this would be a Web-based editor with change tracking that outputs [some flavour of] Markdown.

Anyone know of such a thing? Or something that fits my requirements [explicit or as yet unconscious ;) ] even better?

UPDATE:

pt. 1

This (hallo.js) is very close to what I'm talking about, I just need more headings (H3 etc.), commenting, visible change tracking, and simple tables in addition.

pt 2.

This (ice) is the sort of change tracking in mind.

Load Full (4)

Login to follow topic

More posts by @Murray831

Login to post a comment!

4 Comments

Sorted by latest first Latest Oldest Best

10% popularity

As of 2017, Authorea might be the way to go. It has all the suggested features, and in contrast to the other answers, it is finally an editor that actually supports collaborative commenting.

As a plus, authors can choose whether they want to write their paragraphs in Markdown, LaTeX, HTML, or RichText.

Load Full (0)

10% popularity

Etherpad.

It has

Commenting PLUS change proposals PLUS attribution
Output as plaintext (even better than Markdown for the workflow)
Collaboration in realtime with color coding
Minimal WYSIWYG
A local installation for security

Load Full (0)

10% popularity

Draft seems to satisfy your requirements. The versioning process is done by drafting (hence the name) but it's almost the same thing.

Load Full (0)

10% popularity

Ideally, the reviewers don’t get to do any editing, no matter what the workflow. Even if they just want to see a small change like uppercasing a word, it is better if they just put in a comment and you make the changes. Or not, if you have a reason to reject the proposed change. That way you can maintain strict control of your master document. Again, no matter what the workflow, but especially with Markdown, where your manuscript is a letter-perfect source code for building published HTML or RTF or PDF.

So your workflow could be:

write document in Markdown
convert Markdown to RTF for Microsoft Word or PDF for Acrobat
distribute Word or PDF document to reviewers who only modify the document with comments
receive reviewed Word or PDF document
review each comment in turn and apply changes to original Markdown document
if another review round is needed, go to step 2
convert finished Markdown to HTML for publishing

Generally speaking, editing privileges are for co-writers or editors to make extensive changes, but minor changes should just be made as comments. If they have additional content like a table or photo, they can just put a comment “table X goes here” and send you the table in an Excel document or wherever they made it. So you don’t necessarily need a complicated workflow.

Load Full (0)

Back to top