Re: Software Design Specification

[David King <amigadave amigadave com>]

On 2011-10-25 11:50, David Descoteaux <ddes310 yahoo com> wrote:
> My team and I are at a point where we are creating a design document which will ultimately guide how the features will be implemented. As a result of this, I would like to ask you if there are any design diagrams that anyone has in their possession. System-architecture, System Level, Programming Interface,  Data Interface, and / or Design diagrams are what we aim to include in the document.

I do not think that any architectural diagrams exist. You might not be 
aware of the libcheese documentation:

http://developer.gnome.org/cheese/unstable/

This is the API reference for a library that is installed alongside 
Cheese and which applications can use to monitor connected video devices 
(CheeseCameraDeviceMonitor), take a photo for use as an avatar 
(CheeseAvatarChooser) and display a standalone photo/video capture 
widget (CheeseWidget). There is little in the way of documentation, but 
the public interface is a good place to start.

The private API is not documented, but is mostly concerned with the 
user-visible components such as the Cheese window, thumbnail display and 
preferences dialog.

> Our intentions are to keep any established formats of Software Architecture consistent with what may already exist, so any type of diagram that could be provided will be exceedingly helpful.

It is possible to add diagrams and more text to the libcheese 
documentation, which is in a DocBook XML format, but this requires that 
someone creates the relevant material.

If you have any specific questions regarding the Cheese architecture or 
interfaces, please continue to ask them on the mailing list, as I can 
work the responses into the documentation.

--
http://amigadave.com/