Skip to content

A Focus On Focus

Its another week of uncomfortable temperatures, so I am putting even more effort into focusing on specific tasks. When the temperature gets closer to 30 Celsius I'll spend more time thinging about specific issues (or sleeping if it gets too hot).

Saturday was cooler and I stayed up late to start migrating Practicalli books to the Practicalli Megalinter Custom Flavor for Zensical projects.

The first run of the Megalinter workflow with the Zenical flavour took 54 seconds, significantly faster than the 6 minutes 14 seconds of the previous workflow that was using the Megalinter documentation flavor.

An AliExpress sale on Sunday gave me an opportunity to pick up some new disc brake pistons at a reasonable price 🎌.

Technical Writingλ︎

A discussion about writing on the Clojurians Slack had me thinking about how much I have written about writing and technical writing specifically.

Not all writing should concern itself with a high level of clarity, some writing can just be for fun.

For example, writing a journal can be a purely enjoyable or cathartic activity. I often use my journal as a brain dump to capture hightlights of the week.

I will often use the journal to capture step by step actions I took when doing something new, so I know exactly what was done. This level of detail is invaluable when troubleshooting issues. The steps can be used to write an accurate technical guide for a wider audience.

When creating a technical guide for an audience, then structure and clarity becomes important. Consideration for the audience must be baked into the writing, or at least an up front expectation of the audience experiences.

Writing Techniques - Engineering Playbook

Proselintλ︎

Proselint is a lint tool for the English natural language.

Megalinter includes Proslint.

Configure via a proselint.json file in the current working directory or any directory above the current working directory

Practicalli prefers using the $XDG_CONFIG_HOME/proselint/config.json location,

Neovimλ︎

Opening the Mason tool in Neovim I searched for 'prose' and found the proselint tool.

i to install the tool and proselint was working as soon as I opened a markdown file.

Proselint first pointed out an unnecessary use of 'very' in sentences. It suggests using 'damn' instead of 'very' and your editor will remove them (this also works psychologically for me).

Proselint suggested using curly double quotes instead of straight quotes. Ascii doent support curly double quotes, but Unicode does. I an curious how to enter unicode characters in Neovim. I remember there is a way to add unicode characters in Emacs (Spacemacs).

”Unicode curly double quotes” entered by using Kitty Unicode support.

Ctrl+Shift+u displays the unicode menu. Press . followed by the number associated with the unicode character in the menu.

Unfortunately, curly double quotes for keyboard keys syntax does not work for MkDocs static site generator.

Adding a configuration for Proselint at ~/.config/proselint/config.json, I haven't been able to disable the curly quotes error message. Perhaps I need to update something in the none-ls plugin config.


Thank you.

🌐 Practical.li Website

Practical.li GitHub Org practicalli-johnny profile

@practicalli@clj.social