Writing

As a (very) frequent writer and editor I often find myself writing and correcting the same words over and over again. Or in preparation for publishing I have to repeatedly undertake the same steps, such as adding short codes or formatting links.

I spent a long time researching, trying and tweaking text editors. As a cross-platform developer and technical writer (mostly writer these days) I work with different programming languages, document formats and want an editor with particular features, but that is also easy on the eye. Ideally I wanted all the functionality I was looking for in one application, not split between 5.

When you've spent a lot of time working on the latest great project, library, service or platform you generally would like people to use it. Whether people find out about you from a presentation, the media, internet search or word of mouth, what's the first aspect of your project that people usually encounter?

If you've wanted a spell checker or autocorrect that simply does more, check out how this tool is bein used to check for tense and syle as well.

Ten days ago Kevin Small posted Visualizing Bitcoin Transactions in 3D and Virtual Reality, making it the 500th post submitted to Kauri. We thought this was a great time to recap and recount some of our and your favorite posts from the past year since Kauri began.

Documentation structure applies to your documentation as a whole, and to each page. Let's start at the top and work down.

What's one of the first things you look at when you look at using a new project?

I appreciate that not everyone who writes documentation is a native English speaker, or even if they are, may not understand the best way to write clearly and concisely. Many native English speakers had our last grammar lesson more than 20 years ago, and have learnt the tips and tricks we now use as professional writers recently. There are three important things to remember to justify the time and effort of making your writing more understandable:

For Nanowrimo (national novel writing month) 2021 I continued my novel from last year. To remind anyone who hasn’t followed my sparse updates on the novel, the novel is a speculative fiction set after a global zombie and human conflict where the two (let’s call them) species coexist in a tense harmony. For Nanowrimo this year, I set myself two targets.

How many words do you write every day? Think about it. Every time you send an email, post in Slack, or comment on an Instagram post. Oh, you thought I would mention those wondrous words you pour into your latest novel, blog post, marketing copy, or script?

Who do you think reads most of your technical writing? Customers? Potential customers?

Much like "googling" has become a generic term for searching, Grammarly has become almost synonymous with a general grammar and style checker, outside of those provided by tools like Word or Google Docs. I have used the pro version for several years, and while its advice is not always correct and inconsistent, it's generally a good aid in giving ideas and pointers for writing. However, every year, that subscription comes up for renewal, and I start thinking about alternatives and features I'd like to have that Grammarly doesn't offer. In this post, I look at the disappointingly few alternatives that exist.