学んだことのひとつは、開発チームと文書作成チームが共にあるプロジェクト、API、またはある技術について密接に協力して文書を作成した場合、その文書の品質が素晴らしいということです。このガイドは開発者と文書作成者が手と手を取って協力するための戦略を示唆するものです。この記事は今も作成中の、生きた文書です。あなたの関わる開発者/文書作成者の協力の過程で別の方法を見出したなら、是非ここにそのアイディアを追加してください!つながり始める理想的には、新しいテクノロジーやプロジェクトが開発され始める時に、開発チームはライターチームに対し文書化の必要のある何かが出てくると知らせるでしょう。ときどきそうはならず、MDNチームはBugzillaを監視して文書化が必要な成果がないのか見ています。完全な世界では、直接的な方法で進歩していきます。チームに新プロジェクトを知らせるための最良な方法は文書化リクエストのバグを報告することです。プロジェクトに関連するバグのリンクが入っていてもとても助かります。情報を共有する情報共有の便利な方法がいくつかあります。バグ単に文書化チームに文書化に影響するバグでフラグを立てることですごく助かります。キーワードとコメントタグを適切に使すうのは長くかかることもあります。詳細は文書を最新化するを見てください。ミーティング開発チームは通常ミーティングをします。チームはミーティングに誰かを出席させようとします。何が起きているか、スケジュールはどうか、などを知るのは良い方法です。文書)で作業し、その文書化の状況のためだけにミーティングすることもしばしばあります。関係する全員にとって極めて有益です。典型的にこれは短いチェックインのミーティングで、次のようなアジェンダを伴います:貢献するライターの短い状況更新。特定文書の状況の質問や、特に急ぐ特定コンテンツの情報や、既存コンテンツの問題への注意などを含みます。質問に答えられるエンジニアがいるのかどうかとか、ライターがそんな種類の質問をできるチャンスです。(音声のみもあり)で開催されます。ドキュメントチーム、その他が集まって作業がどこまで進んだかや、何が出てきたかや、開発者と共有すべき最重要事項は何かといった情報交換を行います。これにより、全員がプロモーションの優先度やトピックの文書化のための同じページに乗ることができて、開発者にとって役立つ方法で知らせることのできるフィートバックを返すことにもなります。チームに集中作業週間やミートアップがあれば、関連ドキュメントのライターの招待を真剣に考えるべきです。まで)、そして彼が誰か派遣できるか確認します。覚えてほしいのは、しかしライティングチームは小さく、集中作業週間に参加できる人がちょっとした注意で見つかることはトリッキーです。大き目の文書化プロジェクトでは文書化ステータスページを使って、作業を完了させるのに何をしないといけないか、また何がすでに完了しているか、追跡しています。このページは達成する必要があるタスクと、各タスクのステータスとを一覧にしています。inbox.現在、ニュースレターは英語でのみ提供されています。従って私の個人情報を扱うことに同意します。