Databases
StackOverflow2013
Postsdbo
POHow do you describe your solution/system?
 

Note that there are some explanatory texts on larger screens.

plurals
  1. POHow do you describe your solution/system?
    primarykey
    data
    text
    <p>I am about to write some standards/guidelines and templates that project managers, developers and business analysts would use. The goal would be to better understand the solution that is or was developed. </p> <p>One part of this is providing a standard/guideline on documenting the solution. E.g. documenting the piece of software which solves/meets the business-case/user-requirements.</p> <p>Now, being a programmer myself I can see that it is impossible to dictate and say "each solution must define X using Y and presenting it according to Z.", as X Y Z is not always applicable etc.</p> <p>However, I know even for my hobby projects I always end up describing my solutions one way or the other, modules/components, source code comments, API, database model, some taxonomy used, a journal-log, xml format etc..</p> <p>So in order to continue with my work, I would much appreciate if you could share what you document in order to describe your solution (and preferably also how and why) - I know it will vary greatly depending on many things but any general or specific answer is of interest. Thanks.</p> <p><strong>update</strong> It was not clear, but I was not referring to user requirements with X Y Z. I was referring to all the possible types of documentation a system may have. So read it as "impossible to state that each solution must have: list of required frameworks; operational manual for the server software; required master data; matrix of user requirements vs tests; user interface specification. While it makes sense to produce a such limited set of requirements, it is difficult to be clear and precise as what is the most important/relevant is different from project to project.</p> <p>Also, I asked this quite a while ago and never accepted an answer, sorry for that. Perhaps, since it is an open question, it would be better as a community wiki?</p>
    singulars
    1. PO
      singulars
      1. PTAnswer
    1. This table or related slice is empty.
    1. PTQuestion
    1. USskaffman
    1. USj-a
    plurals
    1. PL
      singulars
      1. LTLinked
    2. PL
      singulars
      1. LTLinked
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. PO
      singulars
      1. PTAnswer
    2. PO
      singulars
      1. PTAnswer
    3. PO
      singulars
      1. PTAnswer
    1. VO
      singulars
      1. POHow do you describe your solution/system?
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. POHow do you describe your solution/system?
      1. This table or related slice is empty.
      1. VTUpMod
    3. VO
      singulars
      1. POHow do you describe your solution/system?
      1. USJosh
      1. VTFavorite
    1. This table or related slice is empty.
 

Querying!

 
Guidance
A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.

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