Machine learning (ML) has the potential to advance the state of the art in technical writing. No, I'm not talking about text generation models. The ML technology that might end up having the biggest impact on technical writing is embeddings. What embeddings offer to technical writers is the ability to discover...
I’m building a web crawler so that I can track how pages in my docs site link to each other and to the outside web more broadly. If a lot of my docs pages link to some particular page, then that page is probably important. PageRank Lite, basically, except with much more focus on intra-site backlinks.
A quote from Every Page Is Page One that has deeply changed how I approach technical writing.
I have been tasked with the fascinating and somewhat-overwhelming project of migrating pigweed.dev's build system from GN to Bazel. These are my notes on the project.
Just append #page=X to your URL, where X is the page you want to deeplink to.
I'm trying to become proficient at keyboard-only navigation and have learned that a lot of docs sites aren't friendly to people who rely on Tab...
Where should I put the search box on my documentation site? What text should I put inside the search box? What should happen when I type stuff into the search box? What should the search results page look like?