Skip to main content

Posts

Showing posts from July, 2026

Document formatting carelessness is really annoying

In my line of work I sometimes need to write technical or other types of documents. I was once tasked with writing what was essentially an explanation and tutorial on a particular task in a particular embedded system scenario using certain libraries, as I had been working on that and they wanted me to write a clear tutorial and specification of how it was done, for others employees who may need to work on the same or similar things. The document ended up being, if I remember correctly, about 30 to 40 pages long, and I took particular care to make it as clear and legible as possible, paying special attention to its layout. I added page breaks if needed to make sections, sub-sections, tables, lists and code samples be all contiguous on the same page if needed, or if eg. a code sample was so long that it necessarily needed to be on two pages, I made certain that the page changed at a clear logical place in the code (rather than being, for example, between an "if" line and its bo...