4月18日土曜日、3回目の「ハイパーバトン」が開催されました。これは、Yandexがテクニカルライターとドキュメント作成プロセスに関係するすべての人のために開催した会議です。
「ハイパーバトン」はモスクワの「ヤンデックス」のオフィスで開催されました。 会議場の入り口で、おもちゃの達人ヨーダが皆に挨拶しました。

参考 :会議の名前は偶然に選ばれたわけではありません:事実は、 ハイパーバトン (一見するとハイパーバトンではない)は言葉が完全に魔法のように通常の順序を変えるスピーチの図であるということです。 。
なぜこれが重要なのでしょうか?
一般にオープンソースで作業する場合、プログラミングの動きを記述する能力は大きな利点を提供します。 たとえば、アフィリエイトテクノロジーの統合を担当するチームからの承認(およびカルマとコード評価の利点)は、そのアクションを明確に説明できる人によって受け取られます。 特にOpenStackについて言えば、開発者のコミュニティに参加するには、コードを書く能力だけでなく、 自分のやっていることを論理的かつ簡潔に説明する能力、仕事の必要性を正当化する能力は、イニシアチブの成功に大きな影響を与えます。
ハイパーバトンに戻る

よくあることですが、主催者は特に際立っていました。 Yandexの同僚は、テクニカルライターの仕事のさまざまな側面に関する優れたプレゼンテーション( こちらでご覧いただけます )を発表しました 。
何を言いたかった?
スヴェトラーナ・カユシナ氏は、チームメンバーの数の変化に応じて、Yandexのテクニカルライターの進化について、経験、議論、技術的な説明、追跡作業がどのように行われたかについて、魅力的な経験について話しました。
Alexey Zamullaは、メンタリングについての彼自身の印象を共有しました。判明したように、指導者と研修生の両方がメンタリングから利益を得ています。 優れたフィードバックを得て、時間とタスクを管理する方法を学ぶ可能性が大幅に増加しました。
ダリア・エレミーナは、一見したところ、非常に簡単にdrれがちなビッグプロジェクトへの没入のテーマを取り上げました。 本当に、OpenStackコミュニティに積極的に貢献しているテクニカルライターに馴染みのある問題です-インスタントメッセンジャー、バグトラッカー、およびバックログの数はグラフから外れています。 ダリアは、問題をさまざまなフロー、つまり人の流れ、タスク、情報、時間、そして当然のことながら注意を払うことで動作するものとして提示した。 ダリアは、私たちの仕事は時々モンキービジネスに似ていることもあると断言しましたが、ドキュメントを正確にするのは細部への注意です。
Artyom GorbunovのDesign BureauのMaxim Ilyakhovは、実際にマスタークラスを開催し、 手首を軽く振って、テキストを簡単に、読みやすく、わかりやすくする方法を示しました。 特に楽しいのは、「言語のゴミ」の存在をテキストで確認するためのリソースを提示したことです。意味を失うことなく簡単に捨てることができる不要な単語やフレーズです。 最も注意深いプレゼンテーションの誤りを見つけ、頭蓋骨と素晴らしい編集スローガンのある面白いステッカーを受け取りました。

欲しいものを見つけますか?
テクニカルライターは、多くのトピックに関する質問をしました。専門家のための書き方、プロのスラングを使用するかどうか。 技術ライターのメンターへの動機付け方法、および初心者だけでなく互いに教え合うことが可能かどうか。 テクニカルライターが重大なバグを見つけて開発者の尊敬を得ることができますか?これらは議論の一般的な輪郭にすぎません。
これはすべて、OpenStackコミュニティに実行可能な貢献をするか、私たちの場合のように(Fuel and Mirantis OpenStack)個人的な問題の解決に取り組んでいるすべての人によく知られています。
Mirantisでの仕組み
弊社のテクニカルライターは、マルチタスクモードで作業し、新しいリリースのためにドキュメントを更新したり、バグを修正したりするために、片方の目で上流を一目見ようと、もう一方の目でローカルの問題を見ようとしています
ただし、Mirantisの特徴-すべての来訪者へのガイドの開放性-誰でも変更を加えて、上記についてコメントし、最良のオプションまたは文言を提供することができます。 メンタリングの問題は私たちにとって非常に重要です。
この会議により、オープンソースの問題を解決するためのアプローチを再考し、追加のツール(スタイルガイドなど)の作成、既存のツールの改善、およびおそらくドキュメントに貢献するためのよりわかりやすく透明なプロセスについて考えることができました 。
外部からあなたの仕事の有効性を見る素晴らしい機会をくれたYandexに感謝します。 力がすべての私たちと一緒にあるように...言葉!
OpenStackでの作業の説明で問題が発生した場合は、コメントで問題を共有してください。 そして、典型的な困難の分析とそれらを克服する方法の説明に別の投稿をさせていただきます。 そして、たぶん、バンクーバーサミットで同僚がOpenStack Foundationのリーダーシップと議論できる提案を策定することで、エコシステム内のプロセスを改善することができます。