ブログ

成功する開発チームは、コード品質を落とすことなく、素早く動ける必要があります。開発者のクローンを作成することは (まだ) できないため、チームのスピードを上げるにはどのようにしたらよいでしょうか?

次の 2 つの戦略をお試しください: まず、新しいチーム メンバーのオンボーディングにかかる時間を短縮します。次に、チームが技術的な問題の答えを探すために費やす時間を制限します。  

ドキュメントの作成よりも優れた製品の構築に時間をかけたいのは当然のことです。同時に、チームが素晴らしい成果物を構築するためには、優れたドキュメントも必要です。Confluence は、標準技術ドキュメントを簡単に作成および文書化できるようにすることで、この矛盾の解決をサポートします。これにより、だれでも標準技術ドキュメントにアクセスして更新に参加することができます。Confluence を活用して、短期間でドキュメントを効率的に作成できるようになります。

チームが Confluence 内で作成できる 3 種類の標準技術ドキュメントをご確認ください。

1. オンボーディングのドキュメント

新入社員に最新情報を提供することは、開発スピードやチームの将来の成功のために非常に重要です。 

新入社員チェックリスト

新入社員はまず、ガイド付きタスク リストを提供します。エディター ツールバーから任意の Confluence ページにタスクを追加できます。

新入社員用タスク リストまたは 90 日プランでは、指示や便利なリソースを提供します。基幹システムやアプリケーションへのログイン方法、会社ポリシーなどの社内リソースへのリンク、およびチームのメンバーとの面談タスクなどを含めます。

文書化する方法

タスク リストは、正しい方向を示すための優れたリソースです。しかし、彼らに何を示せばよいでしょうか。新入社員が問題を自身で解決できるよう、便利なハウツー文書が必要です。

ブループリントのハウツー記事で始める - 基本レイアウトを提供しているため、コンテンツの追加に集中することができます。

画像、コード ブロック、関連 Web コンテンツへのリンクをページに追加するのを忘れないようにしましょう。

ページの編集が完了すると、一番下にラベル別コンテンツ マクロが表示されます。このマクロは、現在のスペース内にある同じラベルのすべてのページを自動的に取り込みます。

ページが保存されると、同じラベルを持つページの動的なリストが表示されます。

2. アプリケーションおよびネットワーク アーキテクチャに関するドキュメント

これらのドキュメントは、チーム全体が、いつでも利用できるようにする必要があります。Confluence では、次のようにしてアーキテクチャ ドキュメントをまとめることができます。

The most important part of your architectural docs is being able to reference diagrams, components, SDKs, APIs and related docs all in one place. These documents can be as heavy or light on information as you need. At Atlassian, we put all this information in tables. Tables are easy to insert into your page, and flexible. Use the table tools menu to add and cut columns and rows, merge, and highlight cells.

オンボーディング コンテンツと同様に、関連アーキテクチャ ドキュメントすべてにラベルを付けて整理できます。

3. リリース プロセスに関するドキュメント

Confluence で作成して保存するもう一つの重要なドキュメント セットは、リリース プロセスおよびリリース予定のドキュメントです。これらのドキュメントは、リリースを整理し、継続的改善を行う文化の構築をサポートします。また、新しい実践方法を導入してプロセスを改善していけるため、進化し続けるドキュメントとも言えます。そのため、全員が最新かつ最高のドキュメントにアクセスできるようにします。これこそが、Confluence が作られた目的です。

リリース プロセス ドキュメントの 3 つの重要な要素:

• 継続的な更新および改善 - 各リリースがチームの学習プロセスになるべきです。開発速度を改善し、リリース待ちの機能をリリースすると同時に、ドキュメントを最新に保つ必要があります。Atlassian では、情報マクロを、ページの関連性を示す視覚的なインジケーターとして使用しています。 

• Organize related docs – You'll want to document the relevant stakeholders, potential workarounds, and all the necessary comms that go out before and after a release. At Atlassian, we use separate child pages for all of this information. To show all of these related pages, add the children display macro to the top of your page. This macro shows all the subpages of your homepage, so you have quick access to the page you need.

• プロセスの視覚化 - Team Calendar は、チームの休日、Jira リリース、およびイベントを一か所で把握するために作られた Confluence のアドオンです。リリース予定ページにカレンダーを組み込み、全員がリリース日を確認できるようするほか、その期間におけるチーム全体の空き状況を確認することで予定の競合を回避できます。月別、週別、またはタイムライン形式で表示できます。

At a glance: what did you just learn?

信頼性に優れたリッチな技術ドキュメントを一元的に用意することは、開発チームにとって魅力的な作業とは呼べないかもしれません。しかし、チームが素早く動き、よいチームから一流のチームへと進化するのに役立つことでしょう。。この記事説明した内容についてまとめます。

• Page tasks - Create an onboarding task list for all new hires
• How-to article blueprint - Use the included how-to article page blueprint to quickly document important development how-to guides
• Content by label macro - Group all the pages with the same label
• Diagramming add-ons - Create, edit, and share diagrams right within Confluence
• Code block macro - Embed code snippets from any programming language into your page
• Children display macro - Show all the child pages that are organized under your parent release process page
• Info macro - Add a visual callout at the top of your page
• Team Calendars add-on - Visualize release dates, team leave, and other events on one calendar

開発チームで最も大変な作業の 1 つは、チームや組織の全員が常に最新情報を把握できるようにすることです。ある人は「プロジェクト X」のステータスを、他の人はどのような新機能がいつ公開されるのかを知りたいと思います。次の四半期の予定に興味がある人もいます。多くのチームは大規模な会議や大量のメールに大きく依存していますが、透明性や可視性といった点において、これらの選択肢は効果的ではありません。メールを見逃すことも、メールが埋もれてしまうこともあります。大きなアナウンスがあった後に、その内容を参照する方法も、シンプルな質問方法もない場合があります。 

How about a Confluence blog post? In this article, I'll show you how to utilize blog posts to share important news and updates across your development team and greater organization. Blogs are a great tool for keeping teammates and coworkers updated because they don't get buried in all of your email, you can write them using dynamic content like JIRA issues and macros, and they're social which makes it easy to start a conversation with interested stakeholders without a neverending thread of emails. Check out these 3 blogs we publish in Confluence all the time at Atlassian. 

ブログ 1: プロジェクトおよびリリースの更新

At Atlassian, before a new release goes out to customers, a member of our development team writes an internal blog post in Confluence to update Atlassians of what's in the release. Our developers want to know what features shipped and what changes to the products were made. It's the easiest and most effective way to keep everyone up to date.

The easiest way to showcase which features shipped is to bring in issues from JIRA using the JIRA Issue macro , which embeds single JIRA issues or a list of issues in a Confluence page. The embedded issues are dynamic, so anyone can click through to JIRA to get more details about what shipped.

JIRA の課題マクロでできること :

• Display a table of JIRA issues on your page, based on the results of a search using JIRA Query Language (JQL).
• Jira の URL を使用して、ページ上に Jira 課題の表を表示する。
• JIRA のサイトから単一の課題を表示する、または、JIRA のサーチ結果から選択された課題のサブセットを表示する
• JIRA サイトの課題数を表示する
• Confluence にアクセスしたまま、ページで Jira に新しい課題を作成し、表示する。

Jira を Confluence ページに取り込む強力なマクロです。マクロを構成し、Jira から取り込みたい課題を検索する方法について、以降で説明します。

project = "TEST"

project = CONF and component = documentation

Many of our release blogs are pretty simple. The JIRA Issues macro is a great way to quickly whip up an update on the latest product release.  But often we write release blogs that are plain, old fun too – packed with gifs, funny videos, HipChat emoticons, or rambling banter. Below is an example of a blog post that one of Confluence's technical writer's published to notify Atlassian's about some new features available to doggood on our Confluence instance that we call 'EAC'.

ブログを楽しく気軽な雰囲気にすることは、チームや組織とのエンゲージメントを促進する優れた方法です。画面の右側では、投稿を支持するすべてのインライン コメントを確認できます。

ブログ 2: チームと知識を共有する

The Atlassian development teams regularly blog to get help with tough technical problems or to share how they've conquered them. One of the best ways to write about code in Confluence is using the Code Block macro.

コード ブロック マクロを使用すると、適切なシンタックス ハイライトでソース コードをページに表示できます。さまざまなシンタックスやテーマから選択して Confluence でコードを表示することができます。 

マクロをページに追加するには、エディター ツールバーで「挿入」メニューをクリックし、「その他のマクロ」を選択します。マクロ ブラウザーが起動し、「コード ブロック」を検索して選択できます。完了したら、さまざまなフィールドを設定できます。

Here's an example of a blog post from Atlassian's intranet that highlights how we use the Code Block macro.

ブログ 3: 新入社員の紹介

It's important to get new hires started on the right foot. At Atlassian, every employee writes an introductory blog post in Confluence. It's the perfect way for new folks to introduce themselves to the entire organization. This is the perfect way to introduce newbies to Confluence and the organization. Atlassians can welcome new hires by adding comments. It's a very positive first interaction with Confluence and the organization at large.

自己紹介のブログ投稿を作成するにはいくつかのポイントがあります。

タイトルを工夫する

自己紹介のブログ投稿を他の人に見てもらいたい場合、タイトルを工夫しましょう。いくつか例を挙げます。

• Ryan Anderson applied to work at Atlassian and you won't believe what happened next... 
• Ryan Anderson™ を正常にインストールしました
• 新しいキャラクター(文字)が作成されました: Ryan Anderson

ページ レイアウトを使用してブログ投稿を整理する

Use page layouts to organize your blog post into sections and columns. A good tip to working with Page Layouts is to click the 'Add Section' button a few times to give yourself some blocks to work with. Then as you build your page you can choose the various column arrangements. You can always switch them later.

多くの画像を使用する

The best way to make a great first impression is to wow people with cool pictures of your travels, favorite foods, hobbies, or your family. In Confluence, adding pictures is as easy as drag and drop, so don’t be shy about showing off. Just drag a picture (or pictures) from your hard-drive and drop them into the Confluence editor. Confluence will attach the images to the page and place them inline. You can then click and drag the images wherever you want on the page.

すべてが完了すると、チームと共有するために最適な、次のような美しいブログ投稿ができるでしょう。

At a glance: what did you just learn?

ブログ投稿を使用すると、アナウンスや状況報告を提供し、その他のタイムリーな情報を簡単に共有できます。この記事で学習した内容をチームで実行して、開発チームやさらに大きな組織でのチームワーク向上に役立つブログ文化を始めましょう。ここで説明した内容は次のとおりです。

• JIRA Issues macro : Bring your JIRA issues into your Confluence pages
• Code Block macro : Display your source code in your Confluence pages
• Page Layouts : Organize your blog post with different column layouts
• Adding Images : Drag-and-drop is the fastest way to insert and image or file into a Confluence page
• Image effects : Add effects to your images to give them some more color

この内容はお役に立ちましたか? 素晴らしいブログ投稿を作成できたなら、@Confluence にスクリーンショットをツイートしてプレゼントに応募しましょう!

Loved this page? Share it on Twitter

ソフトウェア リリースの文書化は、ソフトウェア開発チームの仕事の不可欠な要素であり、リリースの公開そのものと同じぐらい重要です。これには、次のような理由があります。 

• 可視性の増加 - リリースを文書化することで、チームの作業内容や、プロジェクトのマイルストーンに対する進行状況を確認できるようになります。 
• 継続的改善 - アジャイル チームは、各リリースを改善しようと努めています。リリース レポートを定期的に作成することで、チームは、完了した作業と、それらをどのように改善できるかを確認できます。
• 履歴の参照 - 過去の特定のリリースで完了した内容を、いつでも確認できます。 
• コミュニケーションの向上 - リリースの内容をサポート チームや運用チームに明確に報告し、詳細を含む課題リンクを提供します。

文書化の作業は、チームによっては好意的に受け入れられない場合があります。ただし、ここで案内する内容では、面倒な雑務や大幅な時間の浪費はありません。

If you track and report most of your work in JIRA, the integration between Confluence and JIRA makes it easy to insert your release results straight from JIRA into a Confluence page, where you can add more color and detail, publish internally, and also make them publicly available.

内部用リリース レポートを作成する

Start with the JIRA Reports Blueprint in Confluence. Select Create from template from the top nav (3-dot button next to ) > JIRA report > Change log  Create          

変更ログ レポートを選択し、内部用リリース レポートを作成します。このレポート タイプは、指定されたリリースまたはプロジェクトで完了された Jira 課題の詳細な概要を提供します。Confluence のレポートの作成ガイドを利用して、報告するリリースと、レポートに含める内容を指定できます。

適切なプロジェクトを選択します (複数の Jira インスタンスがある場合は、使用するサイトも選択します)。変更ログの作成画面で適切なフィールドに入力し、作成を選択します。変更ログ レポートには、Jira から指定したデータや、編集および調整できるその他の重要なページ要素が含まれます。 

You can either create a dynamic or a static list of issues. Because release notes are a point-in-time communication, a static list is best. If you'd rather include a dynamic list, hit the Switch to advanced link and enter custom JQL. (See the documentation for the JIRA report blueprintfor more details.)

編集モードではページは次のようになります。

ページの上部:

保存後:

ご覧のように、この変更ログはバグ修正に焦点を当てています。

Confluence は Jira での課題タイプに基づいて、リリースを自動的に「バグ修正」、「新機能」、「改善」などに分類します。この自動化は非常に便利で、手動で編集や書式設定を行う手間が大幅に削減されます。

公開用リリース ノートを作成する  

独自のリリース ノート テンプレートを作成して、何度も使用できる、カスタマー用の完全なリリース ノートを作成します。弊社が Jira リリース ノートをドキュメント サイトで公開する際に使用するテンプレートの例を次に示します。

テンプレートには、ページ作成者のガイドに役立つ説明テキストを含めました。一番上には、リリースの内容または主なテーマをまとめた短いテキストを含めることが重要です。ただのバグ修正の場合、このスペースに追加することはほとんどありません。ただし、メジャー リリースの場合、新機能の影響などに関するテキストを追加することを検討してください。

ページに含まれる内容:

マクロ:

• • Table of contents macro – Gives a brief summary of everything in your release notes.
  • JIRA issues macro – Details all the issues that were resolved in the release as well as how many votes popular issues have received.
      

ページの拡張:

• • スクリーンショットとビデオ - メジャー リリースの場合、新しい機能と改善点を紹介するスクリーンショットやデモ ビデオを追加できます。

• • Permissions and restrictions – Permissions are important with release notes. Keep release notes private while you draft, and make sure to review them thoroughly. (Inline comments in Confluence are reeeeeally handy for reviewing docs.) Once they are ready for the public, you can adjust viewing restrictions. (For even more details, read our guide on using Confluence for public-facing technical documentation.)

リリース ノート テンプレートの編集と整理

任意のページ テンプレートにさらに詳細を追加できます。内部および公開リリース ノートで「バグ修正」や「新機能と改善」のセクションを使用して、公開済みまたは修正済みの内容をを整理できます。マクロ (イメージ、スクリーンショット、およびビデオ) を追加することもできます。 

2 つの点に留意する必要があります。

1. リリース ノートは、組織内のユーザーにも、組織外のユーザーにも重要です。
2. Confluence でリリース ノート テンプレートを設定することで、最小限の労力で両方のオーディエンスに情報を伝えることができます。

リリース ノートのコンテンツに関する 6 つの考慮事項

1. 対象者: リリース ノートは誰を対象としていますか? リリース ノートを作成する前に、対象者について考えてください。

2. タイミング: 読者はリリース ノートへいつアクセスしますか? リリース日、またはリリース前ですか? この情報を使用して、レビュー期間などの、リリース ノートの作成スケジュールを設定します。

3. 完了: 何が完了していますか? リリース ノートを、新機能、機能強化、およびバグ修正などのセクションに分けて、完了した内容を一目で確認できるようにします。

4. 編集: リリース ノートに複数の投稿者がいる場合、読者に見られたくない情報が追加されている場合があります。リリース ノートは慎重に編集してください。注: 1 つの機能追加や機能強化についてのスクリーンショットなどの情報が、ほかの機能などに対する情報よりも詳細な場合、その項目の重要性や複雑性を相対的に反映しているように受け取られることがあります。

5. 事実を重視: 事実を記載することが何よりも重要です。リリース ノートは、完全かつ正確である必要があります。 

6. ストーリーとメッセージ: ストーリー展開を使用した説明は、改善点を説明するのに役立ちます。読者に、変更点と、それらが彼らにとって重要な理由をわかりやすく伝えることができます。

開発者と製品マネージャーが継続的に更新できる共有ドキュメントを使用することで、一人のユーザーがドキュメントにかかりきりになることを防ぐことができます。また、リリース ノートは他の情報形式へのハブとしても役立ちます。アプリ内通知、製品ツアー、ブログ投稿、ニュースレター項目、およびヘルプ/サポート資料用のコンテンツを使用しましょう。

まとめ

優れたデザインのリリース ノート ページ テンプレートと、十分に考慮した便利なコンテンツを併用することは、作業を文書化する責務を満たすだけでなく、対象者との関係を深め、反復可能で一貫性があり、優れたコミュニケーションを実現するリリース ノートの作成に役立ちます。

リリース ノート ページ テンプレートに追加するアイテム:

• Table of Contents macro : Create a list of heading links for quick navigation.
• JIRA issues macro : Detail all the issues that were resolved in the release and show issue voting.
• Excerpt macro : Reuse certain content for your release notes.
• Include Page macro : Include content across multiple pages.
• 水平線: +挿入 メニューを選択して、ページのセクションを分割します。
• Permissions and restrictions : Take control of who can view your pages with permissions and adjust viewing restrictions.

nifty リリース ノート ページを作成した場合、@Confluence にスクリーンショットをツイートしてプレゼントに応募しましょう!

Loved this page? Share it on Twitter

We make countless tough decisions every day at work that take collaboration and careful deliberation – that's what makes them so difficult. Most teams rely on a meeting to make a big decision, but it can be hard to actually make the decision in person. Many times a follow-up meeting is required. Most people are much more comfortable making a decision asynchronously. There's no place better than Confluence.

We have a saying around Atlassian: Decisions don't require handshakes. The Decisions Blueprint provides a simple, repeatable process for making decisions asynchronously amongst your team and recording them forever in Confluence so you, or anyone on your team, can reference them later.

Confluence で稟議書ページをセットアップするための 5 つの手順を見てみましょう。

ステップ 1 定義: 誰が、何を、いつ。

すべての決定には、次の 3 つの重要なコンポーネントがあります。何を決断する必要があるか。この決断を下す必要があるステークホルダーは誰か。いつまでに決断する必要があるか。

グループが決定すべき内容を明記する

Usually this is best answered with another question. What should we name our new Q&A add-on for Confluence? (Answer: Confluence Questions ).

この質問は、ページのタイトルで尋ねるのが最適です。これにより、後から探す必要があるときに、稟議書が大幅に見つけやすくなります。

ステークホルダーと意思決定者を定義する

役割を定義する手順は、あらゆる決定で忘れられがちです。意思決定者とステークホルダーの 2 つのグループがあります。意思決定者は、最終決定権を持つ人物です。多くの場合はページの作成者ですが、チーム リーダーやエグゼクティブの場合もあります。ステークホルダーは、この決定に関わる必要がある人物です。この人々が、決定に効力を及ぼします。

@メンションを使用して、このページを意思決定者やステークホルダーと共有します。これにより、ページの保存時に、彼らが意思決定ページにアクセスして取り組むための招待メールが自動的に送信されます。この操作を行うと、完了後にページを共有する必要がなくなります。

決定を行う必要があるタイミングを定義する

決定はある時点で行う必要があります。永遠に議論を続けることはできません。日付ピッカーを使用して期日を設定し、自分たちの分担に時間的制約があることを全員に周知します。

ステップ 2. 書き込み: コンテキストを提供して全員に周知する

情報を整理する

会議を主催する場合とは異なり、全員がすべての情報を確実に入手したうえで考えを投稿する必要があります。ほとんどの場合、選択肢は A と B の 2 つになります。ページ レイアウトを使用してページを整理して、選択肢を区別します。

ページ レイアウトで作業するためのヒントは、「セクションの追加」ボタンを数回クリックし、作業するブロックを複数用意することです。2 番目のページ レイアウト ブロックにカーソルを置いて、2 列レイアウトをクリックします。

ここから、2 つの決定のセットアップを開始できます。最初の列に見出しを追加します。見出し 2 を追加する簡単な方法は、「h2」と入力することです。

ここから、私はテーブルを使用して選択肢を整理するのが気に入っています。テーブルは、情報を整理し、ページを読みやすくできる強力なツールで、オプション A のメリットとデメリットを示すシンプルなリストを簡単に作成できます。2 つの列と、5 または 6 行を選択します。後からいつでも追加できます。

Give each of your table column heading. And then using the  and  emoticon, you can start creating a list. For a check mark, type '(/)' and for a negative mark, type '(-)'.

視覚化する

画像を含める場所の決定が必要となる場合があります。この手順は、Confluence では非常に簡単です。画像がコンピューター上にある場合、ドラッグ アンド ドロップで、画像を Confluence エディターのインラインに配置し、ページに添付できます。

他の情報にリンクする

Confluence の優れた点の 1 つはリンク付けです。すべての作業とドキュメントが Confluence 内にある場合、それらを簡単にリンクして、チームメイトに認識させることができます。これは、決定の背景を提供するのに非常に役立ちます。ページをリンクさせる方法は複数あり、こちらからご覧いただけます。この投稿では、リンクのオートコンプリートを使用する最も早い方法を紹介します。

「[」と入力すると、最近閲覧したページのリストが表示されます。

入力すると、リンクするページを Confluence 全体から検索できます。非常に簡単です。その Confluence ページへのリンクがすでにある場合、エディターに直接貼り付けると、Confluence によって自動的にページ タイトルのリンクに変換されます。

ステップ 3. ディスカッション: 詳細に議論し、合意に達する

＠メンションを使用して既にステークホルダーとページを共有していますが、共有ボタンを使用してページを共有することもできます。これにより、このページにアクセスするよう、チームメートに通知が送られます。

全員が稟議書ページにアクセスしたら、有意義な話し合いを進めやすくなります。あらゆるメンバーがコメントやいいねを付けてフィードバックを提供し、詳細を検討し、考えられる解決策について話し合い、合意に達することができます。すべてのやり取りを 1 か所で行うことにより、受信ボックスからメールのスレッドを探す時間を節約できます。

ページの最後にコメントを残すことができます。

あるいは、インラインにコメントを残すことができます。一般には、背景で何らかの事柄を明確化したい場合に使用します。手順は、ページ上で任意のテキストを選択するだけです。

ステップ 4. 記録: 全員に周知する

チームが決定に達したら、Confluence に簡単に記録できます。関係者全員に通知するよう、ステータス マクロを使用して決定のステータスを変更します。全員が同じページにアクセスしていれば、簡単に先に進むことができます。

ステップ 5. 収集: すべての決定を 1 か所にまとめる

決定理由を後から確認したい場合に備えて、稟議書ブループリントは、1 つのページに決定のインデックスを自動作成します。これで、必要なユーザー全員が、必要な時にすべての決定にアクセスできるようになりました。

まとめ: Confluence でより良い決定を

多数のマクロを使用しているため、このページの作成は難しく思われるかもしれません。しかし、グループとして十分な情報を得たうえで決断を下すことには、労力に見合う価値があります。チームは、選択肢について 1 か所で議論を行い、会議にかかっていた時間や長いメール スレッドを節約することができます。長い目で見れば、一度で決定できることに満足いただけるはずです。ここで説明した内容は次のとおりです。

• ページ レイアウト: さまざまな列レイアウトでページを整理します。
• Emoticons: Use the  and  to give your page some color
• 表: 考えを整理する優れたツールです。
• 画像の追加: 画像またはファイルを Confluence ページに追加する一番早い方法はドラッグ アンド ドロップです。
• リンク付け: Confluence 内のすべての作業で、オートコンプリートを使用して関連ページを簡単にリンク付けできます。
• コメント: ページの最後には全体的なコメントを、インラインにはターゲットを絞ったコメントを追加します。
• ステータス マクロ: 色やテキストを更新して決定事項を示します。

This post is part of our latest collection, A Software Team’s Guide to Confluence. Click the lovely green button below to see more. 

Creating a collaborative product requirement

We've written quite a bit about the conundrum of writing requirements in an agile environment. The most important takeaway is: the best way to kick-off your software projects is to build a shared understanding amongst your team. At Atlassian we find the best way to do this is to create a collaborative product requirement to hash out details for large complex epics. When your requirement doc is created and the details are all in one place, it makes it a lot easier for Development and Design to provide immediate feedback and input. When this happens you can iterate quickly and implement work right away. Here's how you can create that requirement and build a shared understanding in Confluence:

1. 製品要件ブループリントを開始する

付属の特別なテンプレートで開始します。このテンプレートは、正しい方向性で進められるように、含めるコンテンツに関するいくつかのベスト プラクティスを提供します。 

2. キーの詳細を伝える

要件ページは特定の機能のみの要件を示している場合や、複数の機能を含むリリースとしての要件を示している場合があります。いずれにしても、簡単に参照できるページ上部の主要な概要をご確認ください。

• Participants: Who is involved? Use @mentions to include the product owner, and other stakeholders.
• Status: What's the current state of the program? Use the status macro to quickly show if you're on target, at risk, delayed, deferred, etc.
• リリース目標: リリースはいつを予定していますか? JIRA を使用する場合は、JIRA プロジェクトにリンクします。

3. 目標、ビジネス目標、戦略的適合性を概説する  

The team goals and business objectives section is meant to give you a chance to add some color and context to your requirement. 

目標について考えるための正しい方法は、顧客の視点から考えるということです。顧客が達成しようとしていることは、正確にはどのようなことですか? 提案しているソリューションはその目標に対して、どのように適合していますか? 

This is a great place to link to other Confluence pages to provide more detail including customer interviews, and planning pages.

4. Create user stories

表を使用して、説明、優先度、メモと併せてユーザー ストーリーをリストに洗い出しましょう。また、この表は、より詳細な調査ページと顧客インタビューにリンクするのに最適な場所です。 

5. ユーザー エクスペリエンスとデザインをレビューする

Drag-and-drop design files to embed them on your page. If you're embedding multiple design assets use the attachments macro to create a quick repository of all the files that are attached to the page.

6. 質問と説明に対処する

As the team understands the problems to solve, they often have questions. Create a table of "things we need to decide or research" to track these items. 

Keep the team focused on the work at hand by clearly calling out what you're not doing. Flag things that are out of scope at the moment, but might be looked at later. 

7. JIRA 課題の要件を追跡

お客様やその開発チームのほとんどは、JIRA で多くの時間を費やしているでしょう。Confluence の要件は JIRA エピックに極めて簡単に表示できます、その逆も同様です。保存したページの上部にある JIRA リンク ボタンをクリックすると、任意の Confluence ページにあるすべての JIRA リンクを表示できます。

8. 製品要件のインデックス ページ

通常、ユーザーは単一のプロジェクトのみに取り組んでいるわけではありません。Confluence は、チームのすべての製品要件の主要な詳細をプルするインデックス ページを自動で作成します。このインデックス ページには、スペース サイドバーからいつでもアクセスできます。

これは、チームが現在何に取り組んでいるのか、またはこれまでに何に取り組んでいたのかを俯瞰的に確認する際に便利な方法です。Confluence のあらゆるページと同様に、このインデックス ページも必要に応じて編集できます。 

ボーナス: チームのワークフローに合わせて製品要件ブループリントをカスタマイズする

You can edit the Product Requirements blueprint at any time and tailor it to fit your team's specific needs. If you want to edit the template for your specific team or project, go to the Space Tools menu and select Content Tools. Under the Templates option you can view and edit any of the templates included. If you're a site admin you can also edit the global template to customize it company-wide.

At a glance: what did you just learn?

アジャイル要件で重要なことは、チーム間で共通の理解を構築することです。このためには、Confluence で大まかな要件ドキュメントを作成して、重要な課題の開発と設計の全体でコラボレーションする方法が最適です。テンプレートをガイドとして使用して、チームや会社のワークフローに合わせてカスタマイズしてください。

Here's the completed requirementand a rundown of what we covered:

• 製品要件ブループリント: 必要な作業のほとんどが網羅されています。ページの要点に従って、特定の要件に適したコンテンツを入力します。
• Page properties macro: This macro makes it possible to create a reporting page across all your requirements. When using the blueprint it will be included on your page.
• Product Requirements index: Once you've created a few requirements pages, you can see all the high level details at a glance on an index page that Confluence automatically creates when you use the blueprint.
• Create JIRA issues: Highlight text on the requirements page to quickly convert it to a JIRA issue. 
• File comments: Add your design files to the page and encourage discussion on them with pinned comments.
• JIRA links: Just look in the page header to see all the JIRA issues that are included in the requirement. 
• Customizing Blueprints: You can edit any of the blueprints that come included in Confluence to fit your specific workflow.

This post is part of our latest collection, A Software Team’s Guide to Confluence. Click the lovely green button below to see more.

 Find this page helpful? Share the love on Twitter

あらゆる製品リリースの背景には、何時間もの作業と、個人やチーム間での数えきれないほどの調整業務があります。場合によっては、専任のリリース コーディネーターが充てられ、開発者、製品マネージャー、またはプロジェクト マネージャーなどの他の担当者がリリース計画を担当します。

At Atlassian, we use Confluence to collect and organize all the work and information for each release, and to communicate what it's all about to the rest of the business.

I've written before about how we approach releases, what goes into them, and how we organize them. In this post I'll cover exactly how to build an awesome release planning page that will help you do the following:

• 主な目的、ユーザー、および高度なロードマップを特定する
• 関連するすべての背景情報と実行中の作業を収集する
• Jira および関連ページに関する詳細を同僚に知らせる

作業するメンバー全員のための単一の信頼できる情報源を提供し、リリースを開始段階から成功に導くことができます。次の手順に従い、リリース計画ページを作成しましょう。

ステップ 1: 主な情報を特定する

リリーズ計画ページにアクセスしたユーザー全員が、関係者、目標、期待される結果などをすぐに特定できるようにすることが非常に重要です。作業が完了すると、一番上の部分は次のようになります。

空白ページを作成し、2 列ページ レイアウトを追加して、すべての重要な情報をスクロールすることなく確認できるようにします。ページ レイアウトはエディター ツールバー内の次の場所にあります。

メンバーの特定

Add a table inside it that displays the high level details of your release. We like to use the profile picture macro, which you can find in the macro browser or by pressing { and then typing "profile picture", to display each person's image. This helps people put a face to a name, especially when we're working in remote teams. Hover over someone's name in an @mention and you'll find a bit more information about that person.

リリース詳細の特定

You'll also want to capture critical details like the name of the release, expected ship date, and the status of the planning page or even the release itself. We use the status macro to communicate status of pages or individual line items. You'll find it in the "Insert more content" button in the editor toolbar or by pressing {. Change the text and the color to indicate changes in status.

計画ページのステータスの例:    DRAFT  IN REVIEW  CURRENT

リリースのステータスの例: PLANNING IN PROGRESS AT RISK  SHIPPED

また、リリースの最も重要な目標と、目標に含めないもの (リリースの範囲に含めないことを明示的に決定した内容など) も含めます。この情報は、その判断を行った際のページや、チームが目標を設定した際の背景情報を含む他のページにリンクするのに便利です。

ステップ 2: 計画を視覚化する

We like to sketch a roadmap to get a rough idea of how various streams of work will fit together and to communicate the timing within the team and to others. We use the roadmap macro in Confluence to visualize our plans at a high level. (Note: when we want to create a data driven roadmap and determine what's possible given our resources, we use JIRA Portfolio). 

他のマクロと同じように、ロードマップ マクロを挿入します。その後、作業ストリームの追加レーン、エピック用バー、およびマイルストーン用マーカーなどの組み合わせを追加して、必要に応じて詳細またはシンプルなロードマップを作成できます。バーを動かしてさまざまなタイミングを試し、ドラッグしてサイズを調整します。 

バーとしてリストした特定のエピックや機能について、ユーザーにさらに情報を提供したい場合、任意のバーをページに追加できます。よくある例として、詳細情報を含む製品仕様へのリンクを提供することがあります。「挿入」をクリックしてページにロードマップを追加します。計画が変更された場合は、ロードマップを編集し、必要に応じて項目を動かします。 

ステップ 3: 情報を連携させる

リリース計画ページの作成の最後の段階では、ユーザーと、彼らが必要とする情報とをつなげます。これはリリース プロセスに応じた方法で設定できますが、いくつかの基本的なヒントがあります。

First, link your page to the JIRA epic where you're tracking the work for this release by simply pasting the JIRA link into your table at the top. If this release requires multiple epics, you might want to include them in a table below the fold. Paste the issues in so you get the latest status, dynamically updated.

Second, add the children display macro at the top right of your page, above your roadmap under a heading that says "Related Pages". This displays the child pages (sub pages, if you will) of the release planning page. You can specify how many pages and what content to show in the macro editor.

このリリースと関わりのあるページは計画ページの子ページとして作成して 1 箇所に集められるよう、チームに働きかけます。計画ページの前に作成されたページがある場合、そのページを動かして子ページにすることもできます。ページは、右上の「...」ドロップダウンから動かすことができます。

リリース用に作成するページには一般的に以下が含まれます。

• デザイン ハブ - 関連するすべての UX/UI デザイン用
• 競合製品の考察 - 他のツールの取り組みについての概要
• 分析 - 利用をどのように測定するか? 他のどの機能の利用が影響を受けるか?
• 成功条件 - 満たすべきメトリックは何か?
• ワークショップの議事録- 関連する打ち合わせやワークショップでの持ち帰り事項やホワイトボードの内容
• ユーザー テスト - 新しい機能のユーザー テストに関する計画とメモ

最後に、スクロール後に表示される部分にリンクとコンテキストを追加して、だれでも必要な追加情報を取得できるようにします。一般的には次のようなものを追加します。

• カスタマーのために解決しようとしている問題の概要
• パブリックな課題追跡アプリケーションである Jira の関連する機能リクエストへのリンク 
• このリリースに必要なエピックの大まかなビュー
• リリースに関するオープンな質問の一覧

We finish off the page with a release checklist using tasks. Create a task list with the check box in the editor toolbar, or type a left bracket "[" then a right bracket "]" to create a task. You can assign tasks with an @mention and add a due date by typing "//". This lightweight task list makes sure we don't forget any of the little things before we release.

最終的に、リリースしようとしている内容およびその背景、関係者、予測されるタイムライン、必要な詳細情報へのリンクを網羅するページを作成できます。

At a glance: what did you just learn?

さまざまなマクロや情報を含む提案をさせていただいたため、ページの作成は難しく思えるかもしれません。しかし、一度作成すると、すぐに使い方を理解していただけます。ここで説明した内容について、詳細のリンクを以下に示します。

• Page properties macro: put the table at the top inside one of these to make collecting release pages easy. 
• Page layouts: Organize your page with different column layouts
• Profile picture macro: Helps put a face to a name, especially in distributed teams
• Status macro: Communicate status or use it as a colorful label
• Roadmap macro: Sketch a visual roadmap with just a few clicks
• JIRA links: Connect your page in Confluence with your project and epics in JIRA
• Children display macro: Expose related pages and encourage organizing all release information under the planning page
• Task lists: Assign tasks with due dates to make sure the little things get done.

This post is part of our latest collection, A Software Team’s Guide to Confluence. Click the lovely green button below to see more.

Find this page helpful? Share the love on Twitter

「共有されない知識は捨てられた知識である」

– 非常に賢い同僚の言葉

I mean it in the most respectful way possible when I say that we software makers are inherently lazy. Else, why would we choose careers making computers do repetitive tasks for us? It's this laziness that also motivates us to continually improve the way we work and the products we make – we want life to be easier for both ourselves and our customers. 

But learning and improving is really hard if you have to learn the same things over and over again. Even the ancient humans knew this, so they got into the habit of writing stuff down (proving that software makers don't hold a monopoly on strategic laziness). Fortunately for homo modernus, we can skip the carving of stone tablets and use Confluence instead. 

我々はソフトウェア開発者として、チームや製品に起きている内容の詳細を学ぶため、スプリントのふりかえりとデモに重点を置いています。ここでは、学んだ内容を記録し、チーム外と共有するためのページの構築方法を紹介します。 

スプリントのふりかえり

Confluence gives you a big leg up with the Retrospective Blueprint. If you've never used a blueprint before hit the ellipsis next to the Create button at the top of the screen, select Retrospective, then hit the Next button. You'll be prompted to choose a title for the page and indicate which team members participated – they'll be @mentioned on the page, which means Confluence will share the page with them automatically.

すべてが完了したら、ダイアログの一番下にある作成ボタンをクリックして新しいページを起動します。ブループリントはページを、上セクションと下セクションは全幅、中央は 2 列レイアウトの、複数のレイアウトを持つセクションに分割します。 

段階を設定する

ブループリントで必須ではありませんが、1 カ月 (または 1 年) 後に再びページを開いたときに記憶がよみがえるよう、このスプリントで焦点を当てていた内容の説明を 1～2 文追加することをお勧めします。 

アイデアを残す

The Retrospective Blueprint defaults to a "what went well / what didn't go well" format, which allows the whole team to help translate one person's feedback into actionable tasks. If your team is more experienced, you can easily adapt the blueprint to use a "start / stop / continue" format – either instead of or in addition to the default sections provided.

To split that section of the page into three columns, place your cursor in one of the two existing columns, click the Page layout button in the editor, and select the three-column option. Then copy the contents of an existing column into your new third column and update all three headers appropriately. And if you use both mechanisms in your retrospective, add a new section to the page by clicking the Page layout button, then Add section, and choose the three-column layout for the new section. 

これで、ユーザーとチームが議論した内容を簡単に記録および分類できるようになりました。しかし、最も重要なポイントである、次のスプリントで優先させるべき事項は、どのようにして判断できるでしょうか。 

At Atlassian, our teams put it to a vote. Each team member gets to up-vote 3 items in each category, which we represent with an emoticon placed next to the item. Here are some suggestions:

•  – キーストロークは (+)
•  – キーストロークは (-)
•  – キーストロークは :-)
•  – キーストロークは :-(

•  – キーストロークは :-P

•  – キーストロークは (y)
•  – キーストロークは (n)
•  – キーストロークは (on)

ページを保存すると、パネルは次のような外観になります。 

ポジティブなふりかえりを行う

成功するチームが持つ 1 つの習慣に、チーム メンバーがスプリントで行った良い行いを互いに共有することがあります (注: これは対等な関係でのフィードバックであり、マネージャーは含まれません)。ブループリントで作成された「アクション」セクションの上に「Acknowledgements」と入力し、段落 メニューをクリックし、 見出し 2 を選択して、セクション見出しとして書式設定します。ここで、チームは互いに、感謝の気持ちを箇条書きリストとして記載します。

最後に、優れたアイデアを無駄にしないため、行動してください。ブループリントでは、このためのセクションを自動的に追加し、空のチェックリストとして提供します。ここでは 3 つの書式設定機能が非常に便利です。

1. @mentions – so you can flag a team member as owning each item
2. Dates– so you can set deadlines for following up (type // to bring up the date picker)
3. JIRA issues macro – so you can see the progress of larger action items (type { then JIRA to create a new issue without leaving Confluence)

スプリントのデモ

You probably looked at this headline and thought "Huh?!" No worries – we tend to think of demos as happening live and in the flesh (or at least in real time). But for distributed teams, that's not always possible. (And let's face it: distributed teams are as ubiquitous in the software world as Elvis is in Las Vegas.) So when you can't get everyone online at the same tie, recording demos using screen capture tools like Camstudio or Jing and embedding the videos on a Confluence page is a great substitute for doing it live. 

ページ レイアウトを楽しむ

Start by creating a good old fashioned blank page and give it a sensible title that'll make it easy for team members to find through Confluence's quick search or by browsing your team's space. For example, you might create a parent page called Retrospectives, then child pages underneath for each sprint's retrospective notes.

親ページが子ディスプレイ マクロを使用するとさらに良いでしょう。

ページを作成する任意の場所で、ページ レイアウト ボタンを使用して、各オフィスやロケール用のセクションを追加します。私は見出しセクションにはフル幅 (1 列) セクションを使用し、ページを横断する灰色の線を挿入するのが好きです。線を挿入するには、その他のコンテンツを挿入メニューへ移動して、水平線を選択します。 

デモ自体を含むセクションは、2 列レイアウトを使用してページのコンテンツを細かく整理し、読みやすくします。左側の列には、デモの実施者やデモのテーマの情報を含むテーブルを挿入します。その下に、Jira マクロを使用して関連 Jira 課題を埋め込んだり、前述のように、各課題へのリンクを単純に貼り付けたりします。 

ビデオを楽しむ

Over in the right-hand columns, ask each team member to embed their screen captures using either the Widget connector or Multimedia macro. Both are available from the Insert more content menu – choose Other macros at the bottom of the menu to bring up the macro search and selector screen. 

ページを保存すると、次のような外観になります。 

まとめ

ここでは、ブループリント、ページ レイアウト、およびマクロなどのさまざまなものについて説明しました。概要を紹介します。

• ふりかえりブループリント: ふりかえりに必要なほとんどの準備を実行します。空白部分に入力し、情報共有とスプリント概要のためのオプション セクションを追加して、保存をクリックします。 
• ページ レイアウト: ページのすべて、またはほとんどの部分を、1 列、2 列、3 列レイアウトに分割して、ページの見栄えをさらに良くします。ただし、この機能は使いすぎに注意してください。
• Jira リンク: Jira 課題へのリンクを貼り付けるか、Jira マクロを呼び出して検索します。 
• プロファイル画像マクロ: チーム メートの顔を確認できます。
• ウィジェット コネクター マクロ: YouTube, Vimeo、Twitter、または SlideShare リンクを貼り付けます。このマクロはページでのコンテンツの見栄えを良くします。 
• Multimedia macro: Use this to upload .mp4 video images directly from your computer. Or .mp3 files if you care to provide a soundtrack for demo viewing 

This post is part of our latest collection, A Software Team’s Guide to Confluence. Click the lovely green button below to see more. 

Loved this page? Share it on Twitter!