跳到主要内容

3 篇博文 含有标签「Technical Writing」

Blog posts related to technical writing

查看所有标签

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.

Enable User Feedback in Writerside Using TiDB Cloud and Cloudflare Pages

· 阅读需 8 分钟

I am currently using Writerside, a new Integrated Development Environment (IDE) designed for technical writers, to create and develop the documentation website for my side project, PingCAP Docsite Preview. Throughout my experience with Writerside, I discovered an undocumented feature: a feedback module. I have utilized Cloudflare Pages Functions and TiDB Cloud Data Service to process the feedback received through this module and store it in the database.

This guide provides step-by-step instructions for integrating a feedback module into your website. It utilizes Writerside, Cloudflare Pages Functions, and TiDB Cloud Data Service for this integration. This will enable you to collect valuable user feedback directly through your website.

View the demo code: writerside-feedback-example

Try the feedback widget: Feedback example page

Code-Driven Documentation: How to Eliminate Errors in Configuration Documentation

· 阅读需 11 分钟

This document outlines how to utilize code to enhance the accuracy of configuration documentation, particularly for technical writers who might not be well-versed in coding but are responsible for creating or reviewing configuration files. By following the examples in this document, writers can ensure that their configuration files are correct, efficient, and easy to understand, while also reducing the risk of errors or inconsistencies.