Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>IF this project of yours is going to enjoy any kind of longevity, you may want to start thinking of using some industry aligned methodology. In the end, you will probably spend allot more time and possibly end up with the same end result.</p> <p>It also depends what level of documentation you are talking about: For Architectural guidance based on the application, take a look at <a href="http://www.codeplex.com/AppArchGuide" rel="nofollow noreferrer">Microsoft Application Architecture Guide 2.0</a> (Recently released).</p> <p>If it's lower level than that, start with something like <a href="http://msdn.microsoft.com/en-us/vstudio/bb608422.aspx" rel="nofollow noreferrer">SandCastle</a> and just expand logically on what it produces.</p> <p>Personally, I like starting with an Interaction diagram, simply showing how all the components of the system interact with one another, then take each component and break it down into classes. Break classes into sequence diagrams, and keep going until you get to method level state charts or however low makes sense for your project.</p> <p>If it's higher level you need, take a look at my earlier post: <a href="https://stackoverflow.com/questions/755540/enterprise-systems-and-application-architecture-best-practise/760643#760643">Enterprise, Systems and Application Architecture (best Practise)</a></p> <p>At the end of the day, as long as it makes logical sense to the people that read it, and it's useful (as opposed to something that you just have to deliver and will never use again) you've done it right.</p> <p>The bigger problem is often keeping documentation up to date. That will very quickly bring you to the process and procedure creation/improving tasks.</p>
    singulars
    1. This table or related slice is empty.
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. VO
      singulars
      1. This table or related slice is empty.
    2. VO
      singulars
      1. This table or related slice is empty.
    3. VO
      singulars
      1. This table or related slice is empty.
    1. This table or related slice is empty.
 

Querying!

 
Guidance

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload