3 links tagged with all of: documentation + technical-writing
Click any tag below to further narrow down your results
Links
This article argues against replacing technical writers with AI, emphasizing the unique human skills they bring to documentation. It highlights the limitations of AI-generated content and advocates for augmenting tech writers with AI tools instead of replacing them. The author urges companies to reconsider their decisions regarding hiring and retaining technical writing talent.
This article critiques Markdown as a format for technical documentation, highlighting its lack of structure and semantic clarity. It compares Markdown to other markup languages like reStructuredText, AsciiDoc, DocBook, and DITA, which offer better support for content reuse and machine readability.
Pinterest faced ongoing challenges with technical documentation quality and discoverability, prompting the adoption of a docs-as-code strategy. This led to the creation of PDocs, an internal documentation system that integrates documentation alongside code, enhances collaboration, and improves discoverability through a centralized platform. Key features include a streamlined UI, version control, and real-time updates to ensure documentation remains relevant and accessible.