Databases
StackOverflow2013
Postsdbo
POHow to share code documentation for a project?
 

Note that there are some explanatory texts on larger screens.

plurals
  1. POHow to share code documentation for a project?
    primarykey
    data
    text
    <p>There was a similar-ish question here on SO <a href="https://stackoverflow.com/questions/9475795/how-do-you-share-code-across-teams-working-on-very-different-projects">https://stackoverflow.com/questions/9475795/how-do-you-share-code-across-teams-working-on-very-different-projects</a> but mine is about writing documentation.</p> <p><strong>Scenario:</strong></p> <p>Let's say my team is working on a software project, a Fany-WordPad like application which has a feature called <strong>Fancy-Word-Art</strong> ( just like MS Office's word Art). Now I wrote the code for the main window( using WPF in .Net, or using Window Builder in Java, doesn't matter which tool/language). </p> <p>Now if my colleague Mr Spongebob is writing the Word-Art part, how would I <strong>tell him</strong> what functions to call / Api to use to draw on my window? i.e. How do I let Mr SpongeBob know that he needs to call GetWindow() method to get a reference to the drawing surface, the parameters he needs to pass along , and so on?</p> <p>I hope I am being clear here. Is this the procedure?</p> <p><strong>Step 1 :</strong> Use your company wiki site to understand your colleague's written code</p> <p><strong>Step 2 :</strong> Write the <code>GetWindow()</code> method so that it works well with the rest of the project</p> <p><strong>Step 2 :</strong> Now put a wiki on your intranet with the method parameters/ data type requirement for your <code>GetWindow()</code> method or use Doxygen/ Confluence as suggested below</p> <p><strong>Step 3 :</strong> Now its your colleague Mr Spongebob's headache how to find how to draw his word-art on my window.</p> <p>This just doesnt sound right .. With tons of functions, Spongebob's life will be hard, just as mine. Both of us rummaging through documentation to find the right functions to do our job. What if then I change <code>GetWindow() to GetWindow(string title)</code>.. Now how do I <code>literally tell</code> the poor spongebob he needs to redo his code.</p> <p>Am I missing something here? Please share your experience, how do you tackle this problem in a real world software house environment? If your fellow developer is on the next table , do you actually <strong>show</strong> them how to implement a certain method as they get stuck, or how do you deal with this situation? thank you</p> <p>Thanks</p>
    singulars
    1. PO
      singulars
      1. PTAnswer
    1. This table or related slice is empty.
    1. PTQuestion
    1. USCommunity
    1. USiAteABug_And_iLiked_it
    plurals
    1. 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 to share code documentation for a project?
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. POHow to share code documentation for a project?
      1. This table or related slice is empty.
      1. VTUpMod
    3. VO
      singulars
      1. POHow to share code documentation for a project?
      1. USiAteABug_And_iLiked_it
      1. VTBountyStart
    1. COThis question is suitable for programmers.stackexchange.com
      singulars
      1. POHow to share code documentation for a project?
      1. USm3th0dman
 

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