What is the best way to document a system metaphor?

Posted by SDReyes on Stack Overflow See other posts from Stack Overflow or by SDReyes
Published on 2010-04-30T18:49:03Z Indexed on 2010/04/30 19:07 UTC
Read the original article Hit count: 492

Filed under:

metaphor

|

documentation

|

project-planning

|

extreme-programming

|

artifacts

A metaphor help us to communicate with our project stakeholders, using a shared set of concepts and analogies. we develop them all the time, in one way or another. even the XP- programming highly recommend to get it defined since project start.

How do you write such thing down in a document (specially if it already exists)? maybe a dictionary-like approach?

UPDATE: perhaps a thesaurus would do it better (synonyms sum).

© Stack Overflow or respective owner

Related posts about metaphor

Metaphor for task synchronization [closed]

as seen on Programmers - Search for 'Programmers'
I'm looking for a metaphor. A friend of mine taught me to use metaphors from nature, everyday life, math, and use them to design my projects. They can help in creating a better design or better understanding or the problem, and they are cool. Now I'm working on a project with hardware and micro-controllers… >>> More
E 2.0 Value Metaphors

as seen on Oracle Blogs - Search for 'Oracle Blogs'
I guess I have been doing this too long. I can easily see the value of Enterprise 2.0 technology for an organization, but find it a challenge at times to convey that same value to others. I also know that I'm not the only one that has that issue. Others, that have that same passion, also suffer… >>> More
What is the best way to documentate a system metaphor?

as seen on Stack Overflow - Search for 'Stack Overflow'
A metaphor help us to communicate with our project stakeholders, using a shared set of concepts and analogies. we develop them all the time, in one way or another. even the XP- programming highly recommend to get it defined since project start. How do you write such thing down in a document (specially… >>> More
What is the best way to document a system metaphor?

as seen on Stack Overflow - Search for 'Stack Overflow'
A metaphor help us to communicate with our project stakeholders, using a shared set of concepts and analogies. we develop them all the time, in one way or another. even the XP- programming highly recommend to get it defined since project start. How do you write such thing down in a document (specially… >>> More
A metaphor for Drupal module's inner workings

as seen on Stack Overflow - Search for 'Stack Overflow'
What is the best application workflow metaphor for Drupal module? In PHP frameworks we think MVC-style. How do we think inside Drupal? Asumming I am writing some user-oriented module like Shop, Catalog or Forum. As far as I understand there are no or few MVC based modules. Should I generally treat… >>> More

Related posts about documentation

Hyperlinked, externalized source code documentation

as seen on Programmers - Search for 'Programmers'
Why do we still embed natural language descriptions of source code (i.e., the reason why a line of code was written) within the source code, rather than as a separate document? Given the expansive real-estate afforded to modern development environments (high-resolution monitors, dual-monitors, etc… >>> More
A tool to aid completion of missing or incomplete source code documentation

as seen on Stack Overflow - Search for 'Stack Overflow'
I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints,… >>> More
Quick C# Project Documentation in Visual Studio

as seen on Internet.com - Search for 'Internet.com'
Here's a quick way to document your .NET projects. >>> More
SQLAuthority News – Feature Pack for Microsoft SQL Server 2005 SP4

as seen on SQL Authority - Search for 'SQL Authority'
If you are still using SQL Server 2005 – I suggest that you consider migrating to later version of the SQL Server 2008/2008 R2. Due to any reason, you wanted to continue using SQL Server 2005, I suggest that you take a look at the Feature Pack for Microsoft SQL Server 2005 SP4. There are many… >>> More
SQLAuthority News – Best Practices for Data Warehousing with SQL Server 2008 R2

as seen on SQL Authority - Search for 'SQL Authority'
An integral part of any BI system is the data warehouse—a central repository of data that is regularly refreshed from the source systems. The new data is transferred at regular intervals by extract, transform, and load (ETL) processes. This whitepaper talks about what are best practices for Data… >>> More