EOL Software Development Guidelines

First page: Purpose

Quick Reference

This top page is an outline and quick reference for the full guidelines document.  Click on a heading to view that page, click on the bullet item to view that section on the page.

Purpose

These guidelines describe best practices for software engineering in EOL. These guidelines are not intended to be mandates.

Project Management

• Consult on Project Management

• Use Agile Development Practices

• Hold project reviews

• Track issues

• Track progress

Development Process

• Requirements

• Design

• Design reviews

• Documentation

• Code reviews

• Releases

• Acceptance or bug-fix phase

• Maintenance

• Pair programming

• Share programming

• Code sprints

Coding Guidelines

• Use automated builds.

• Use automated testing.

• Use continuous integration testing.

• Use compilers effectively.

• Use revision control.

• Use a logging framework.

• Use a consistent style.

• Facilitate code reuse

• Deploy tests and logging as part of production software

• Document

• Do not optimize prematurely

Tools and Technologies

• Editing

• Revision Control

• Unit Testing

• Memory Checking

• Issue Tracking

• Continuous Integration

• Builds

• Code Reviews

• Packaging, Distribution, and Installation

• Graphical User Interface Frameworks

• Web Application Frameworks

• Application Configuration

• Commercial Tools

• Code Analysis Tools

Updating the Guidelines

• Process review

• Practice priming

• Action items

• Open questions

Resources and References

External links, recommended reading, references and other resources.