Writers and Developers: The Dynamic Duo 執筆者と開発者:ダイナミックな2人組

Writers and Developers: The Dynamic Duo
執筆者と開発者:ダイナミックな2人組

Shwetha Madhan, VMware
April 15, 2020
ヴイエムウェア社シュエッサ マダーン著
2020年4月15日
When developers and technical writers work well together, they both take advantage of their relationship and bring out the best in each other. This article highlights the value of an efficient collaboration which can improve the quality of the documentation.
開発者と技術執筆者が一緒によく働くとき、彼らは彼らの関連を利用するのと、お互いでのベストを出すことの両方をします。 この投書ではドキュメンテーションの質の改善可能な効率的な協働の価値に興味を集中します。
Although we don’t always think of developers and their relationship to documentation, in a real-world, documentation is as important to a developer as all other facets of development. Most developers spend hours not just writing code and designing a digital workspace, but actively engaging with the community and trying to learn new things. Developers must know how to communicate technical requirements and specifications to other stakeholders as they often contribute to content that goes in front of the customers. They must write clearly and concisely. The ability to deconstruct coding in simple words sets them apart. Developers have to explain technical terms and concepts in a way that makes sense to less technical team members. So, coding is not the only “unicorn” skill for designers and developers.
我々が常に開発者とドキュメンテーションへの彼らの関連について考えるわけではないけれども、実世界では、ドキュメンテーションは開発の他のすべての側面と同じぐらい開発者にとって重要です。 たいていの開発者は、単にコードを書いて、デジタル作業領域を設計しているだけでなく、積極的にコミュニティーに関わりを持って、そして新しいことを学ぼうとして何時間も費やします。 開発者は、彼らがしばしば顧客の前に行くコンテンツに寄稿するから、どのように他の利害関係者に技術要件と仕様を伝えるべきか知らなければなりません。 彼らははっきりと、簡潔に書かなくてはなりません。 単純な言葉で開発コードを解体する能力は彼らを優位に立たせます。 開発者は、意味をなす方法でそれほど技術的でないチームメンバーに専門用語と概念を説明しなければなりません。 それで、ソフトのコード化は設計者や開発者にとっての唯一の「ユニコーン」技能ではありません。


In a real SaaS-paced world, developers are often under pressure to develop new features and solve issues quickly. The rapid pace of a faster and better digital landscape means that product innovation occurs in days, not years. With limited time and bandwidth, writing in simple, plain language may not be the top priority for our developers. Their main area of expertise is not content development. Expecting a developer to always think like a writer and take the time to explain technical terms in simple language is easier said than done.
実際のサービス型ソフトウェアが先導する世界で、開発者はしばしば新しい機能を開発して、素早く問題を解決するプレッシャーを受けています。 より速い、そしてより良いデジタル風景の速いペースは製品革新が、何年もではなく、日々で起こることを意味します。 限定された時間と帯域幅で、単純で、平易な言葉で執筆することは我々の開発者にとって最優先ではないかもしれません。 彼らの専門知識の主な分野はコンテンツ開発ではありません。 開発者が常に執筆者のように考え、単純な言語で専門用語を説明するのに時間をかけることを期待することは言うは易く行うは難しです。

ここから先は

10,844字 / 1ファイル

¥ 100

期間限定!PayPayで支払うと抽選でお得

この記事が気に入ったらチップで応援してみませんか?