Creating Release Notes

When you release that great new version of your software, your customers are going to want to know what's fixed and what new features you're giving them. FogBugz makes it easy to maintain release notes as you go along, effectively attaching a release note to any case. When you're done with a release, you can easily aggregate all of these notes into a single document.

■Note You will almost certainly not want to add release notes to every case. Some are too trivial for customers to care about. Others might reflect bugs that were introduced during development and fixed before any customer had a chance to see them, so customers will have no reason to care.

FogBugz does not attempt to compose release notes automatically based on the bug report, because bug reports are not usually worded the way you want your release notes to be worded. By the time you're done working on a case, the text of the bug might include internal code words, abbreviations, notes on competing products, and even rude back-and-forth between developers and testers. Rather than showing all of this junk to the end user, FogBugz requires you to create your own release notes specifically for this purpose.

You can add release notes to any case that has been resolved, whether it has been closed or not. When you open up a resolved case, you'll see a link at the top allowing you to edit release notes, as shown in Figure 4-13.

Figure 4-13. Preparing to enter release notes for a case

Click the link to open an editing screen, as shown in Figure 4-14.

To see all the release notes for a particular release, go to the FogBugz home screen by clicking the FogBugz icon in the top-left corner of any page, and then click the Release Notes link. Choose the release you are working on, and you will see a list of cases that were resolved for that release. From here you can jump to any case to edit its release notes. Figure 4-15 shows the release notes in progress for a particular release.

Figure 4-14. Editing release notes for a case

-'^j FogBugz - Microsoft Internet Explorer

_

JnJjiJ

1 File Edit View Favorites Tools Help

#

^ Back T O T 0 @ P Search ^ Favorites ^ Media

® 1 - «E3

Address http : //shoof ly. larkgroup. larkf arm. com/FogBUGZ/def ault. asp?pg

=pgListReleaseNotes8(ixFixFor=3&OK=OK

IflGo

Links >J

FogBugz

User: Valerie Shriver

Administrative Tools:

search

List New Case Send Email Options Filters Discuss Snippets LogOff Users Projects Mailboxes Clients Departments Priority Licenses Site

Release Notes - ServiceMonitor: 1.0

I Edit

Case

Status

Title

Release Notes 1

Éf •

J_4

Resolved (Fixed)

Problem with Service Monitor beta

Now works properly with free e-mail accounts such as HotMail or Yahoo.

Éf 9

II

Resolved (Fixed)

Service Monitor install failure

Service Monitor can now be installed successfully on a Windows 2000 Domain Controller.

(Fixed)

Service doesn't start without reboot on some operating systems

Installing on Windows 2003 no longer requires a reboot.

(Fixed)

Service doesn't start without reboot on some operating systems

Show Release Notes for: | ServiceMonitor: 1.0:9/1/2005 T]

Installing on Windows 2003 no longer requires a reboot.

d i http : //shoof ly. larkgroup. larkf arm. com/FogBUGZ/def ault. asp

Figure 4-15. Notes for a release

At the bottom of this screen are two button links, one marked HTML and one marked XML. These icons are used to export the release notes to external files.

The HTML link displays all the release notes on one page. It uses extremely clean HTML with all formatting done in a style sheet. You can use your favorite HTML editor to format the release notes any way you like. By editing the styles, you can control the formatting of the entire release notes document to match your exact requirements. Figure 4-16 shows a set of release notes in HTML format.

ä Release Notes - ServiceMonitor: 1.0 - Microsoft Internet Explorer

^jnjx

File Edit View Favorites Tools Help

QBack - O T 0 @ Ô I P Search Favorites ^ Media ^ | M T

Address |;jf] http : //shoof ly. larkgroup. larkf arm. com/FogBUGZ/download. asp?pg=pgReleaseNotesHTML&ixFixFor= ▼ | H Go Links

Release Notes - ServiceMonitor: 1.0

14: Problem with Service Monitor beta

Now works properly with free e-mail accounts such as HotMail or Yahoo. 15: Service Monitor install failure

Service Monitor can now be installed successfully on a Windows 2000 Domain Controller. 7: Service doesn't start without reboot on some operating systems

Installing on Windows 2003 no longer requires a reboot.

Produced by FoqBuqz d

Figure 4-16. HTML release notes

The XML link displays the release notes in XML format, suitable for any further processing you may need to do to integrate the release notes with your Web site, documentation, or any other electronic interchange or content management system. Figure 4-17 shows a set of release notes in XML format.

'1 http://shoonyJarkgroupJarkfami.conVFogBUGZ/dow —g

-LelJ-XJ

1 File Edit View Favorites Tools Help

1 # 1

Q Back Q - 0 ® '.¿1 | P Search "¿j" Favorites ^ Media & \ ^ M

Address http;//shoofly.larkgroup.larkfarm.com/FogBUGZ/download.asp?pg=pgReleaseNotesExport&jxFixFor= ▼ | Go

Links " |

<?xml version="1.0" encoding="utf-8" ?> - <ReleaseNotes>

<ixBug>14</ixBug> <sCategory>Bug</sCategory>

<sTitle>Problem with Service Monitor beta</sTitle>

<sReleaseNotes>Now works properly with free e-mail accounts such as HotMail or Yahoo.</sReleaseNotes> </bug>

<sCategory>Bug</sCategory>

<sTitle>Service Monitor install failure</sTitle>

<sReleaseNotes>Service Monitor can now be installed successfully on a Windows 2000 Domain Controller.</sReleaseNotes> </bug>

<ixBug>7</ixBug> <sCategory>Bug</sCategory>

<sTitle>Service doesn't start without reboot on some operating systems</sTitle> <sReleaseNotes>Installing on Windows 2003 no longer requires a reboot.</sReleaseNotes> </bug> </ReleaseNotes>

Figure 4-17. XML release notes

0 0

Post a comment