Talk given to C++ class at Blue Ridge Community College.

1. Documentation
IN THE AGILE DEVELOPMENT SPACE
Presentation to the C++ Class, Blue Ridge Community College

2. Abel Lineberger,
PMP CSM
Project Manager for {SAW} Software
Mill
Asheville, NC
Contracts Manager for PageEuropa
Port Special Systems Contract
Port Khalifa Project, UAE
Testing & Commissioning Deputy
Manager
Port Special Systems Contract
Port Khalifa Project, UAE
Technical Project Manager for
InControl Systems
Belmont, NC

3. Matthew
Alverson
Senior Software Engineer Team Lead
for {SAW} Software Mill
Asheville, NC
Mortgage Operations Manager
First Citizen’s Bank
Mortgage Information Systems
Manager
First Citizen’s Bank

4. Agile Manifesto
http://agilemanifesto.org/iso/en/
We are uncovering better ways of developing software
by doing it and helping others do it.
Through this work we have come to value:
Individuals and interactions over processes and tools
Working software over comprehensive documentation
Customer collaboration over contract negotiation
Responding to change over following a plan
That is, while there is value in the items on the right,
we value the items on the left more.

5. Types of Documentation
FORMAL
Req’d by
◦ Contract
◦ Stakeholders
◦ Business Unit
◦ Corporate governance
Requires
◦ Consistent structure
◦ Formal review
INFORMAL
Req’d by
◦ Development teams
Requires:
◦ Speed of creation/update
◦ Speed of search/retrieval
◦ Loose structure
◦ Metadata
◦ Ease of use
◦ Ease of capture

6. Types of Documentation
FORMAL
Examples
◦ Project Charter
◦ Project Documentation Standards
◦ Project Communications Plan
◦ Project Risk Mitigation Plan
◦ Project Status Updates
◦ Project Close Documentation
◦ Technical Documentation
◦ End User Documentation
INFORMAL
Examples
◦ Interteam Communication
◦ Intrateam Communication
◦ Ad hoc meeting documentation
◦ User Stories
◦ Spikes
◦ Embedded Comments
◦ Technical Documentation
◦ End User Documentation

7. Methods of Documentation
FORMAL
Documents
◦ Word
Email
◦ Outlook (Gmail)
Scheduled Conference Calls
◦ POTS (Skype, Webex)
INFORMAL
Wiki
◦ Confluence
Instant Messaging
◦ HipChat (or Slack, etc)
Ad Hoc Conferencing
◦ Skype (or HipChat, Slack, etc)

8. Agile Manifesto meets Project
Requirements
Our documentation should:
1. Act as a point to start conversations
2. Be lightweight (min/max)
3. Capture customer requirements
4. Be dynamic (open to change)

9. Validation
AGILE MANIFESTO
1. Individuals and interactions over
processes and tools
2. Working software over comprehensive
documentation
3. Customer collaboration over contract
negotiation
4. Responding to change over following a
plan
DOCUMENTATION REQUIREMENTS
1. Act as a point to start conversations
2. Be lightweight (min/max)
3. Capture customer requirements
4. Be dynamic (open to change)