跳到主要内容

1 篇博文 含有标签「Memoir」

查看所有标签

Keeping Docs in Sync: My Journey So Far

· 阅读需 7 分钟

I first came across technical writing in 2021, when I was looking for a job in my final year at university. I'd never considered it a career, but the job description felt familiar enough that I applied.

I'd been keeping a blog for a year or two, recording how I got things working and what went wrong along the way, in case I needed to do it again. I wrote about assignments from a Python data analysis course, deploying Hadoop, and sharing one mouse and keyboard across multiple computers. Beyond the blog, I wrote a handover guide at the end of an internship, explaining how to run a program I'd built.

At the time, my understanding of technical documentation came entirely from those personal how-to guides. I assumed documentation was simply a record of a process that had already worked: someone did the work, wrote down the steps, and anyone who followed them would get the same result.

That assumption didn't survive what came next.