On Sat, Dec 17, 2016 at 9:40 PM, Manish R Jain <[email protected]> wrote:
> I meant these templates: > https://en.wikipedia.org/wiki/Help:Template > > Google Docs is nice and easy WYSIWYG, but the end result isn't going to be > as good; because it's HTML output is going to be manual and basic. It's > designed for documents, not really documentation. Not to be facetious, but can you describe the difference between "documents" and "documentation?" I don't know what it is. Documentation is documents AFAIK. You could document your project with LaTeX and that would be a fine choice. LaTeX produces documents. I think what you might mean is that there's a shortage of semantic markup to address the specific needs of documenting a software artifact. For example, the absence of a "code block" element. I would agree to that, if that's what you mean, though in my specific case I feel that the enhanced collaborative ability has largely made up for it and the occasional annoyance at having to make a code block into a meaningless "Consolas 10pt." > Some of the best documentation is hosted on wiki: > > https://wiki.archlinux.org/ > https://wiki.gentoo.org/wiki/Main_Page > > Not to mention Wikipedia itself. I say this, because we had the same > discussions when using Wiki for Dgraph as well; and similar points and > solutions were raised. It's an older software, a bit harder to set up, and > uses unpopular syntax, agreed. But, once you get past that, it's a delight > to work with and the end result is just astounding. We couldn't be happier > having made the decision to switch to Wiki. > > > On Sat, Dec 17, 2016 at 07:56:43PM -0500, Martin Blais wrote: > > On Sat, Dec 17, 2016 at 7:25 PM, Manish Rai Jain <[email protected]> > > wrote: > > > > > > > > - And this is where Wiki really shines -- that is templates. You see a > > > section which is incorrect, needs work, out of date, or want to have a > > > special note, add a warning; you can add a special highlighted box in > Wiki. > > > That adds a real value for the end user. No other solution does that -- > > > Google docs or Github. > > > > > > > Not entirely accurate. Google Docs allows the user to either (a) > highlight > > the offending text and leave a comment in the margin (along with a button > > for me to mark it resolved when I fix it and it makes the comment go > away), > > or (b) directly make the suggested edit - an email is sent to me and I > can > > choose to accept or reject it on the spot. No switching to source, no > > markup, it's all right there in the doc and notifications are sent by > email. > > > > -- > > > > --- > > You received this message because you are subscribed to the Google > Groups "Ledger" group. > > To unsubscribe from this group and stop receiving emails from it, send > an email to [email protected]. > > For more options, visit https://groups.google.com/d/optout. > > -- > > --- > You received this message because you are subscribed to the Google Groups > "Ledger" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > For more options, visit https://groups.google.com/d/optout. > -- --- You received this message because you are subscribed to the Google Groups "Ledger" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/d/optout.
