A guide to writing effective AGENTS.md files for AI coding agents, based on research data and best practices.
A summary of key takeaways from Google's Technical Writing One online workshop, covering audience analysis, writing style, and documentation tips.
The author discusses the current state and future potential of AI in software development, focusing on bug fixing, documentation, and the need for developers to stay sharp.
Argues that well-written unit tests serve as the most reliable and up-to-date form of documentation for software code.
A reflection on API design and developer responsibility, using a historical Windows Kernel function as a case study.
Explains the critical role of good documentation in software development, highlighting its benefits for maintenance, onboarding, and knowledge transfer.
Article explains why to avoid adverbs like 'simply' in technical writing to improve clarity and avoid alienating readers.
A developer argues for the value of inline code comments as a durable form of documentation, contrasting them with ephemeral pull request discussions.
Explains the three main types of statistical weights (precision, frequency, sampling), their uses, and the software documentation challenges they create.
A guide introducing the benefits and basics of technical writing for software developers, including skill validation and career opportunities.
A guide to creating effective GitHub README files, covering essential elements like clear descriptions, usage examples, and multimedia to showcase projects.
A developer's blog series detailing their Google Summer of Code 2018 project, implementing features for the SUSI.AI iOS application.
An introduction to Markdown, a plain-text formatting syntax used widely in software documentation, explaining its benefits and basic usage.
Analyzes the time investment and value of code comments, covering initial writing and maintenance costs versus long-term benefits.
A detailed categorization of code comments, exploring their types, maintenance, location, and alternatives to improve code clarity.
A guide for developers on how to approach and manage an inherited legacy codebase, focusing on mindset, planning, and practical steps.
A developer argues for the importance of clean, high-quality code comments and clarifies their relationship to documentation.
