Home > Articles > Software Development & Management > Agile

📄 Contents

  1. Introduction
  2. Documenting the Engine Room
  3. References
  • Print
  • + Share This
Like this article? We recommend

Documenting the Engine Room

How much and what sort of documentation should we create and keep for each iteration through the DBF and BBF activities?

The information captured during any project includes the following:

  • Design and development artifacts (what was done, how it was done, and why it was done that way)

  • Planning, scheduling, and progress tracking (when things were done, how well they were done)

  • Responsibilities (who did what)

We don't want to force developers to spend significant time creating unnecessarily large volumes of design documentation and project plans; many of us working on Internet time can no longer afford the luxury of the time required, and few developers relish the task. The resulting documents are also hard to maintain, seldom fully read and understood, and they're frequently lost over time.

Sometimes, for legal reasons, you have to create large amounts of documentation. Products like Together, which can take comments from source code files and generate documentation conforming to specified templates, can go a long way toward easing the pain. Keeping the documentation in the source code decreases the chances that it will get lost and increases the chances that it's up to date.

The documentation that we create and keep for each DBF/BBF iteration is defined by the tasks; each of the tasks in the DBF/BBF activities produces an output of some sort that we can capture. For example, the DBF task "Form a feature team" results in a list of developers and the BBF task "Implement classes and methods" obviously results in a set of updated source code files (and if you're programming in Java you can generate and capture Javadoc output).

Once we've decided what documentation to keep, the next problem is how to link it all together in a way that makes sense. Imagine that we were doing this manually: A chief programmer (CP) prints a copy of the DBF and BBF activities for his next iteration. He or she assigns a unique name or number to the iteration and writes it on the top of the printout. Next the chief programmer lists the name or ID of the feature or features included in that iteration on the printout. Then, to track progress, the CP writes the completion date next to each task as it's completed.

If we left enough space under each task we could also ask the chief programmer to write the names of the developers in the feature team and the names of any files produced as the result of each task. The printout becomes the integration point for all the documentation created during an iteration.

At this point you're probably ahead of me, thinking to yourself, "What if, instead of printing a copy of the DBF and BBF activities, we used an HTML form instead?" Yes, and with a little work we can add some intelligence to reduce the overhead on the chief programmer—especially if we're already using our project intranet to Track by Feature (see Coad Letter #70 for more details on Track by Feature). This is exactly what we did on one project; we called the resulting iteration web pages "Chief Programmer Work Packages" or "Chief Programmer Work Folders."

Imagine that a chief programmer has identified the feature or group of features to be developed in the next iteration. He or she requests a new work folder for that iteration, giving the iteration a unique name or ID number. Next the CP specifies the features to be implemented in the iteration. If we already have a table of features for the project, the work folder can automatically display the specified features' details. If each feature in our project table is hyperlinked to the relevant use cases, functional specification sections, or domain walkthrough notes, the work folder can also automatically list the relevant documents to study in the third task of DBF ("Study the referenced documents").

The DBF task "Form a feature team" requires the chief programmer to remember or look up the owners of the classes involved in the iteration. If we already have a table on our project intranet relating developers to the classes they own, the work folder can accept the names of the classes involved, and then look up and automatically list the developers required in the feature team. We could even extend this to automatically include hyperlinks to the current version of the Javadoc output (or documentation generated by Together, or both) for the classes involved if that's also published on the intranet. (We used to publish Javadoc as the final step in our regular, automated build process.)

Next, we ensure that each task's outputs are captured in a form that can be published on the project intranet. Then the feature team can publish outputs and add hyperlinks to the work folder as they complete each task. These outputs could include notes from the domain walkthrough task and summaries of the inspection results. (Details of the inspection such as the list of defects found may be too much overhead without a dedicated administrative assistant to do the data entry.)

If the team is using a version control system with a web front-end, we can even generate hyperlinks to the before-and-after versions of the source code files.

In our example, the project management team appreciated the details and information contained in the work folders. The chief programmers and developers also liked them; when working in two or three feature teams concurrently, they could look at the work folder and immediately see how far the team were through the iteration. Also, all the relevant information for that iteration was immediately accessible from one place—a great convenience tool.

Looking at the contents of the work folder, you can identify much of the content that would traditionally be part of a design specification document for a module. Such a document would typically be written by one or two developers and extensively reviewed before coding started. In the meantime, the requirements might have changed and the authors might have been forced to make major modifications to the document before submitting it for review again.

Instead, the feature team members have created much of the content of the work folder together as they worked through the DBF/BBF activities. This helps reduce the number of design errors and spreads the responsibility for the design across the team. Also, the fine granularity of the iterations spreads the documentation load over time. Reviews are done earlier and in smaller chunks, helping to find requirements issues earlier.

I've deliberately left out details of how to implement the work folder; there are many ways to attack each part. Implementation details will also vary according to each team's/organization's project infrastructure.

For most teams wanting to try this out, it's sufficient to produce a very simple prototype at first. Remember that you won't be thanked by your clients for producing the ultimate, web-enabled chief programmer work folder system—your clients want the system they asked you to build.

The conclusion? Chief programmer work folders are a simple, effective solution for document-weary development teams.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020