DevX Home    Today's Headlines   Articles Archive   Tip Bank   Forums   

+ Reply to Thread
Results 1 to 5 of 5
  1. #1
    famin Guest

    General Procedure of Documentation


    Hi all ,

    What is the general procedure for the documentation of a project. What should
    be in details and is it the job of programmer to do the whole documentation
    Thanks
    Fam



  2. #2
    Deborah Guest

    Re: General Procedure of Documentation

    In our shop, the programmers normally do all of the technical documentation
    and "someone else" does all of the user documentation.

    - Deborah

    "famin" <famin01@hotmail.com> wrote in message
    news:3aee3fde$1@news.devx.com...
    >
    > Hi all ,
    >
    > What is the general procedure for the documentation of a project. What

    should
    > be in details and is it the job of programmer to do the whole

    documentation
    > Thanks
    > Fam
    >
    >




  3. #3
    famin Guest

    Re: General Procedure of Documentation


    U didn't answer my first question. The general format of documentation
    Thanks
    Famin



    "Deborah" <deborahk@_insteptech.com> wrote:
    >In our shop, the programmers normally do all of the technical documentation
    >and "someone else" does all of the user documentation.
    >
    >- Deborah
    >
    >"famin" <famin01@hotmail.com> wrote in message
    >news:3aee3fde$1@news.devx.com...
    >>
    >> Hi all ,
    >>
    >> What is the general procedure for the documentation of a project. What

    >should
    >> be in details and is it the job of programmer to do the whole

    >documentation
    >> Thanks
    >> Fam
    >>
    >>

    >
    >



  4. #4
    Joe \Nuke Me Xemu\ Foster Guest

    Re: General Procedure of Documentation

    "famin" <famin01@yahoo.com> wrote in message news:3af6772e$1@news.devx.com...

    > U didn't answer my first question. The general format of documentation


    What, she's supposed to read your mind over the Internet now? While some
    interesting work has been done in the field of mind-reading lately, even
    the use of high-resolution MRI and PET scanners can only tell us whether
    a lab rat is dreaming about running a specific maze and the like. And as
    for using Tempest technology, fugeddaboutit, the signal/noise is way too
    low with current techniques. I guess we'll just have to settle for your
    *telling* us what sort of documentation you're talking about, intended
    audiences, how much effort you're willing to put into keeping the code
    in synch with the documentation, whether your programmer(s) can handle
    non-context-free grammars, etc. etc. etc.

    --
    Joe Foster <mailto:jfoster@ricochet.net> Got Thetans? <http://www.xenu.net/>
    WARNING: I cannot be held responsible for the above They're coming to
    because my cats have apparently learned to type. take me away, ha ha!



  5. #5
    Deborah Guest

    Re: General Procedure of Documentation

    We have some samples on our web site: www.insteptech.com.

    Good luck -
    Deborah

    "famin" <famin01@yahoo.com> wrote in message
    news:3af6772e$1@news.devx.com...
    >
    > U didn't answer my first question. The general format of documentation
    > Thanks
    > Famin
    >
    >
    >
    > "Deborah" <deborahk@_insteptech.com> wrote:
    > >In our shop, the programmers normally do all of the technical

    documentation
    > >and "someone else" does all of the user documentation.
    > >
    > >- Deborah
    > >
    > >"famin" <famin01@hotmail.com> wrote in message
    > >news:3aee3fde$1@news.devx.com...
    > >>
    > >> Hi all ,
    > >>
    > >> What is the general procedure for the documentation of a project. What

    > >should
    > >> be in details and is it the job of programmer to do the whole

    > >documentation
    > >> Thanks
    > >> Fam
    > >>
    > >>

    > >
    > >

    >




Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
HTML5 Development Center
 
 
FAQ
Latest Articles
Java
.NET
XML
Database
Enterprise
Questions? Contact us.
C++
Web Development
Wireless
Latest Tips
Open Source


Top DevX Stories

Easy Web Services with SQL Server 2005 HTTP Endpoints
JavaOne 2005: Java Platform Roadmap Focuses on Ease of Development, Sun Focuses on the "Free" in F.O.S.S.
Wed Yourself to UML with the Power of Associations
Microsoft to Add AJAX Capabilities to ASP.NET
IBM's Cloudscape Versus MySQL


Sponsored Links