Contents

Contents

  1. Implementation Specification for XXX
    1. Overview
      1. Overall Summary
      2. Assumptions
    2. User Interface
    3. Implementation
      1. Code Changes
      2. Schema Changes
      3. Migration
    4. Unresolved issues

Don't edit this page! Make a copy of it for your specification and edit that page.'

Implementation Specification for XXX

Overview

  • Launchpad entry: <none yet>

  • Created: YYYY-MM-DD by (your name here)

  • Contributors: <none yet>

  • Depends on: Is this spec dependent on the implementation of another spec? If n/a replace this text with "n/a"

  • Enhancement Proposal: <link to the Launchpad Enhancement Proposal wiki entry>

Overall Summary

Summary: This should provide an overview of the issue/functionality/change proposed here. Focus here on what will actually be DONE, summarising that so that other people don't have to read the whole spec. Mention tables being created.

Goal/Deliverables: What do we plan to achieve and what actual things will be released/deployed?

Assumptions

A list of assumptions should go here. This should include any assumptions about the users, the workflow, the implementation, the system this will reside on, the hardware requirements, access, etc.. Note that these are assumptions that everyone should believe are "business as usual". If you find yourself writing things which aren't, they are requirements and should be documented in the Implementation section below.

User Interface

This section should cover changes required to the UI, or specific UI features that are required to implement this. It should be a more technical description of what the LEP shows in its UI workflow section.

Implementation

This section should describe a plan of action (the "how") to implement the changes discussed. This could include subsections in addition to what is provided in this spec template.

Code Changes

Code changes should include an overview of what needs to change, and in some cases even the specific details.

Schema Changes

What Database changes are you proposing? Do you need a new index created? Proposing a new table? If so, what does it look like?

Migration

Include:

  • data migration, if any
  • redirects from old URLs to new ones, if any

  • how users will be pointed to the new way of doing things, if necessary. (If your change is big enough, consider using the rollout template.)

Unresolved issues

In this section list out any issues which are unresolved and will impact or block the implementation of this spec.

CategoryProposal CategoryTemplate

ImplementationSpecTemplate (last edited 2010-03-15 16:20:57 by julian-edwards)