User Tools

Site Tools


content:dev:techdoc

This is an old revision of the document!


Serval Project Technical Documentation

All Serval Project technical documentation is (or should be) in Markdown format, which is plain text in UTF-8 encoding using a regular notation for headers, emphasis, links, etc. Technical documentation includes:

  • release notes
  • build, test and installation instructions
  • privacy and data retention policies (which must be distributed with the software)
  • architectural notes relating specifically to the software
  • API documentation and specifications
  • names of contributors

What belongs in Git

All Serval Mesh technical documentation resides within its respective Git source code repositories, for the following reasons:

  • it is closely tied to specific versions of software components,
  • it must be updated as new software versions are produced,
  • prior versions of technical documents must be available along with prior versions of the source code,
  • it is produced and reviewed by the same developers who work on the source code,
  • it is subject to the same copyright assignment, licensing and acceptance procedures as the source code,
  • GitHub renders Markdown and other structured text documents nicely.

Some good examples of technical documentation are:

What belongs in the Wiki

The Serval Project Wiki is used to host documents that are largely independent of specific software versions and releases, and not closely tied to software development processes, such as:

  • orientation and introductory material
  • general Serval Project procedures and policies
  • general information for developers and contributors, including general architectural and API design
  • road map and other long-term planning material
  • lists of useful resources
content/dev/techdoc.1367477162.txt.gz · Last modified: 01/05/2013 23:46 by Andrew Bettison