20130305 SFAUG Confluence Case Study
-
Upload
anthony-pelosi -
Category
Technology
-
view
149 -
download
1
description
Transcript of 20130305 SFAUG Confluence Case Study
![Page 1: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/1.jpg)
Case Study: Using Confluence for
Requirements and Specifications
of a Consumer Electronics Device
Anthony Pelosi, Magellan GPS
![Page 2: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/2.jpg)
Who Am I?Anthony Pelosi (not related to Nancy that I know
of)
Technical Product Manager of Fitness Products at Magellan GPS
Jira & Confluence user for 6 years at 3 companies
Previous Presenter at SFAUG and Atlassian Summit
![Page 3: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/3.jpg)
This Presentation is NOTBest Practices
Introducing Latest Features
Well Polished
Attempt to Promote any Product or Service
![Page 4: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/4.jpg)
This Presentation ISActual Case Study (may be ugly at times!)
Showing Simple Techniques in Powerful Ways
Work in Progress
Going to Inspire YOU to Present in the Future!
![Page 5: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/5.jpg)
Start with a Dream
![Page 6: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/6.jpg)
Followed by a Landing Page
![Page 7: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/7.jpg)
Tip 1: Landing PageIf it takes more than a single URL to point
someone to EVERYTHING they need to know for the product, you did something wrong.
Organize the ContentPage Content: Everything on the page itselfChild Pages: parent-child folder hierarchyRelated Pages: rules based on labels (like Gmail)
![Page 8: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/8.jpg)
Macro: Content by Label Use the “Content by Label” Macro to bring
together Pages & Blog Posts from Various Locations.
Advertise the Macro’s Criteria.
![Page 9: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/9.jpg)
Got Files?
![Page 10: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/10.jpg)
And Feedback?
![Page 11: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/11.jpg)
Tip 2: Files & Feedback For ID presentations, we used a single page with
File Attachments and Feedback as Comments.
Much better than passing back Files and Feedback over email.
If someone sent a File over email, I added to the Page, added a Comment with my Feedback, and Replied to the email with a link to my Comment.
![Page 12: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/12.jpg)
Macro: AttachmentsUse the Attachments Macro to reduce the need
to go to “Tools > Attachments”.
Set the “Allow Upload” Parameter to True
![Page 13: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/13.jpg)
Pages with Same Format?
![Page 14: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/14.jpg)
Tip 3. Use TemplatesFor Software Features, we created a Page for
each Feature.
Each Page has Table of Contents, Version History, Overview, Requirements, Specifications, etc.
Use Templates to ensure consistency across pages.
![Page 15: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/15.jpg)
Macro: Table of ContentsStart Pages with the Table of Contents Macro.
![Page 16: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/16.jpg)
Macro: Version HistoryFollowed by the Version History Macro to show
the most recent page edits.
![Page 17: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/17.jpg)
Requirements in Spreadsheet?
![Page 18: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/18.jpg)
No Problem
![Page 19: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/19.jpg)
Tip 4: Embed Spreadsheets
For Software Requirements, we embedded a Google Spreadsheet exported as an XLS file.
Why didn’t we choose Confluence Tables?Familiar, Faster & Easier to EditAllows for Simultaneous Contributors (Google Doc)
One file attachment, embed anywhere
Split up into different Sheets by category/feature
![Page 20: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/20.jpg)
Macro: ExcelUse the Excel Macro to embed an XLS file.
Specify the file as “page^attachment”.
Specify the Sheet.
![Page 21: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/21.jpg)
![Page 22: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/22.jpg)
Constant Referenceswithin Documentation?
![Page 23: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/23.jpg)
Tip 5: Link toPages and Anchors
Referencing UI Components, Variables, etc. and other well defined entities using Text was sloppy
Referencing with Links forces you to be consistent, organized, and document in a modular fashion (the developers will respect you!)
Use Headers (ex., “h3.”) or Anchor Macro to create Anchors
Link to Anchors using “pagename#anchorname”
![Page 24: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/24.jpg)
Macro: AnchorUse the Anchor Macro when it is not convenient
to use a Header to create an Anchor (for example, to create a reference to a row in a table)
![Page 25: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/25.jpg)
Go With the Flow
![Page 26: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/26.jpg)
Tip 6. Flow ChartsFlow Charts help express written requirements
and specifications visually.
![Page 27: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/27.jpg)
Feeling Wired?
![Page 28: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/28.jpg)
Tip 7. WireframesCreate Wireframes to represent both the
Generic Specifications and Examples of those Specifications.
![Page 29: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/29.jpg)
Mercy!I could go on for hours, but that’s it for now.
Simple techniques can be powerful when used in a well thought out, methodic manner.
![Page 30: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/30.jpg)
Questions?
![Page 31: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/31.jpg)
AppendixJust in Case for Q&A!
![Page 32: 20130305 SFAUG Confluence Case Study](https://reader033.fdocuments.net/reader033/viewer/2022051609/547b9cfe5806b50d408b464d/html5/thumbnails/32.jpg)
All Requirementsin a Single Sheet?
You can use Filters to make a Sheet for each feature using a subset of the Master Sheet.