writing-for-a-technical-audience

Core principle: Technical writing must be clear, concise, and authentic. Clarity and technical depth are not opposites - you can have both. Avoid AI writing patterns that make content feel robotic or inauthentic.

 Why this matters: Developers value their time. Clear documentation builds trust. AI-like writing patterns (identified through research) make content feel generic and untrustworthy. Technical depth without clarity frustrates users. Clarity without depth leaves them stuck.

Research shows specific phrases and structures that readers identify as AI-generated. Avoid these to maintain authenticity.

開発者向けのドキュメント、ガイド、API リファレンス、または技術コンテンツを作成するときに使用します。不正であることを示す AI の作成パターンを回避しながら、明確さ、簡潔さ、信頼性を強化します。 ソース: ed3dai/ed3d-plugins。