To that extent I need to make a ToDo list of the areas I must document. Needless to say that these documents will be but a first draft, and will be subject to refactoring as they are used.
I'll changing the list ad adding / editing stuff with time to reflect my changing ideas and perceived requirements.
The List:
- Processes
- Configuration Management/SourceControl/Subversion Usage
- Continious Intergration (Goal of, Processes and Usage)/ Build Process
- Release Process
- Versioning Policy
- Issue Tracking Workflow (Must also select and set up a tool to support this) (See Issue Tracking & Bug Tracking)
- Document Management Process
- Deployment
- Pear Reviews
- Work Logging
- Process reviews (I've read Martin Fowlers The New Methodology Essay which talks about the motivation behind agile software development. He talks about the need for processes used in development to be self adaptive which I think is imperative to them being adopted,to them surviving the test of time with respect to their usefulness and to their improvement over time. He suggests this is possible via a process review process)
- Standards
- Documentation Standards (Architecture, Design & Implementation)
- Obfuscation
- Project Deliverables (e.g. Code, Unit Tests, Documentation)
- Coding Standards
- Assertions
- Tracing
- Exceptions
- Code Documentation
- Warnings
- Code Metrics
- Globalization
- Naming Conventions
No comments:
Post a Comment