Category: Tech Writing

Doc tools: Overleaf

I’ve been working a lot with LaTeX this year. On my laptop, my preferred toolset is WinEdt and MikTeX, but I’m intrigued by the more portable looking solution of Overleaf.

Overleaf is a web-based LaTeX editor that allows you to store and edit your content in the cloud. You can sign up for a free account if you won’t be using it much, or a monthly subscription to add more projects plus a few extra features.

The site has a good catalog of existing templates you can choose from to start a document, article, presentation, CV, or whatever. They even provide an interactive tutorial to get you up to speed if you’re not too familiar with LaTeX. More advanced users can upload whatever custom/specialised templates and resources they need.

The split-view, web-based editor shows your editable markup on the left hand side, and a dynamic preview of the results on the right hand side. As I’m writing this, there’s a beta RichText view of the sources which shows a bit of a mashup of WYSIWYG and source content depending on which document I’m looking at – I guess it renders what it can parse sufficiently and leaves the rest in its raw format.

The free plan has a limited number of files per project (60), and an overall space limit of 1GB, but you can have as many projects as you like within those constraints, and get almost all the bells and whistles. Also, as seems to be a trend with many cloud-based services, they offer bonus space and features in return for social media interactions, inviting friends, and the like.

If you’re looking for a collaborative/cloud-based solution for your LaTeX project, you’ve little to lose by taking Overleaf for a test drive.

DITA resources

Getting started with DITA? Here’s a quick roundup of some resources that might prove useful:

Got a favourite resource of your own? Let me know in the comments!

Do not spellcheck!

Generally speaking, you should spellcheck everything you write. Word has some fairly decent in-built spelling and grammar checking, and while it may not get everything, it’ll catch a lot. However, on occasion, there’s content you really don’t want to spellcheck. Case in point: API/developer documentation rife with code samples: yes, I did mean to spell it that way; yes, it is all one word; no, I don’t want to capitalise that just because it’s at the start of a line; no, I don’t want a space after that semi-colon… And by the time you’ve hit Ignore for the umpteenth time in a row, you realise you’re back in body text, and you’re not sure how long you’ve been on auto-pilot clicking Ignore, and who knows what garbage you’ve said is ok to leave as is now, and you may as well go right back to page 1 and start over. So what do you do? Forego spellchecking entirely? Copy and paste the non-code-sample bits to a separate doc, spellcheck, then merge back in? Or magically tag the code samples as not to be spellchecked and live happily ever after? It’s a leading question, I admit it. The last option it is, and today’s post is on how to do just that! Continue reading “Do not spellcheck!”

Downgrading Adobe Software

Most writers I’ve worked with don’t know that Adobe will allow you to downgrade a product by one version when you purchase the current version. This could come in useful, for example, if you have an expanding documentation team using software that’s not backwards-compatible (I’m thinking RoboHelp and FrameMaker in particular): instead of upgrading licenses for everyone on the team, you can buy current licenses for the newcomers and downgrade them to be compatible with the software the team is already using. More information is available at Adobe’s page on volume licensing policies.

It would be nice if you could roll back by more than one version, but given the cost of some of these products, having even that much flexibility can be enormously valuable!