Docstoc

raw

Document Sample
raw Powered By Docstoc
					Question                                                    Options                       QID     Type       Letter   Average
Which types of software documentation do you write /
edit / verify? Check all that apply. For this survey
references to the term 'software documentation' imply
documents geared for software developers that support
a given system and NOT for end users.
                                                            Requirements                        1 checkbox   a        --
                                                            Specifications                        checkbox   b        --
                                                            Detailed Design                       checkbox   c        --
                                                            Low Level Design                      checkbox   d        --
                                                            Architectural                         checkbox   e        --
                                                            Testing / Quality Documents           checkbox   f        --
In your experience, who has the prime
RESPONSIBILITY to CREATE and MAINTAIN the
following types of software documentation?<br>
Select 1: Customer(s) / Client(s).<br>
Select 2: Manager / Project Leader.<br>
Select 3: Software Architects. / Sr. Developers.<br>
Select 4: Jr. Developers.<br>
Select 5: Technical Writers.<br>
                                                            Requirements                        2 rank       a                  2.00
                                                            Specifications                        rank       b                  3.00
                                                            Detailed Design                       rank       c                  3.00
                                                            Low Level Design                      rank       d                  3.67
                                                            Architectural                         rank       e                  3.00
                                                            Testing / Quality Documents           rank       f                  3.50
In your experience, who has the prime
RESPONSIBILITY to VERIFY and VALIDATE the
information in the following types of software
documentation?<br>
Select 1: Customer(s) / Client(s).<br>
Select 2: Manager / Project Leader.<br>
Select 3: Software Architects.<br>
Select 4: Developers.<br>
Select 5: Technical Writers.<br>
                                                            Requirements                        3 rank       a                  2.25
                                                            Specifications                        rank       b                  2.38
                                                            Detailed Design                       rank       c                  3.25
                                                            Low Level Design                      rank       d                  2.86
                                                            Architectural                         rank       e                  2.88
                                                            Testing / Quality Documents           rank       f                  3.00
In your experience, when changes are made to a
software system, how long does it take for the supporting
documentation to be updated to reflect such
changes?<br>
Rate 1: Updates are NEVER made.<br>
Rate 2: Updates are RARELY made.<br>
Rate 3: Updates are made within a few MONTH of the
changes.<br>
Rate 4: Updates are made within a few WEEKS of the
changes.<br>
Rate 5: Updates are made within a few DAYS of the
changes.<br>
                                                            Requirements                        4 rank       a                  2.75
                                                            Specifications                        rank       b                  3.25
                                                            Detailed Design                       rank       c                  3.88
                                                            Low Level Design                      rank       d                  3.57
                                                            Architectural                         rank       e                  3.75
                                                              Testing / Quality Documents        rank   f   4.25
In your experience, how effective are the following types
of software documents in reflecting the true state of a
software system. Rate between one (1) as completely
USELESS and five (5) as extremely EFFECTIVE.
                                                              Requirements                     5 rank   a   3.00
                                                              Specifications                     rank   b   3.38
                                                              Detailed Design                    rank   c   3.38
                                                              Low Level Design                   rank   d   3.43
                                                              Architectural                      rank   e   3.88
                                                              Testing / Quality Documents        rank   f   4.50
In your experience, how often do you consult the
available software documentation when working on that
software system? Rate between one (1) as NEVER and
five (5) as ALWAYS.                                           Requirements                     6 rank   a   3.25
                                                              Specifications                     rank   b   4.38
                                                              Detailed Design                    rank   c   4.00
                                                              Low Level Design                   rank   d   3.00
                                                              Architectural                      rank   e   4.00
                                                              Testing / Quality Documents        rank   f   4.00
In your experience, how effective do you find the
available software documentation for a software project
in the following circumstances. Rate between one (1) as
completely USELESS and five (5) as extremely            When LEARNING a software
EFFECTIVE.                                              system.                                7 rank   a   3.63
                                                        When MAINTAINING a
                                                        software system.                         rank   b   3.14
                                                        When TESTING a software
                                                        system.                                  rank   c   3.38
                                                              When other developers are
                                                              UNAVAILABLE to answer my
                                                              questions.                         rank   d   3.29

                                                              When explaining / answering
                                                              questions about the system to
                                                              MANAGEMENT or
                                                              CUSTOMERS.                         rank   f   3.14
                                                              When looking for BIG-
                                                              PICTURE information about
                                                              the software system                rank   g   3.38
                                                              When looking for IN-DEPTH
                                                              information about the software
                                                              system.                            rank   h   3.75
                                                              When working with a NEW
                                                              software system                    rank   i   4.00
                                                              When working with an
                                                              ESTABLISHED / MATURE
                                                              software systems                   rank   j   3.38
In your experience, how well maintained is supporting
software documentation in the following type of software
projects (please note, we are referring to both the quality
and frequency of the updates). Rate between one (1) as
NOT MAINTAINED at all and rate five (5) as extremely
WELL MAINTAINED.
                                                              New or recent projects           8 rank   a   3.63
                                                              Mature projects with new
                                                              functionality                      rank   b   3.25
                                                           Maintenance projects (where
                                                           the software is being
                                                           supported but relatively few
                                                           new features are added)               rank   c   2.88

                                                           Agile or lightweight projects
                                                           (for example eXtreme projects,
                                                           extremeprogramming.org)               rank   d   2.75
                                                           Open source, public domain
                                                           projects                              rank   e   3.50
In your experience, how important is each of the
following items in helping to create effective software
documentation (requirements, design, architecture, …)
to its audience. Rate the LEAST important item as one
(1) and MOST important item as five (5). All other items
are somewhere in between.                                  Length (not too short, not too
                                                           long)                               9 rank   a   3.38

                                                           Availability (ability to retrieve
                                                           the most current version)             rank   b   4.13
                                                           Organization (table of
                                                           contents, categorized, sub-
                                                           categorized, etc)                     rank   c   4.00
                                                           Navigation (internal / external
                                                           links, actual links or just
                                                           references)                           rank   d   3.38

                                                           Document structure
                                                           (arrangement of text, tables,
                                                           figures and diagrams)                 rank   e   3.50
                                                           Document's format (i.e.
                                                           Microsoft Word, Note Pad,
                                                           Visio, Html, Pdf)                     rank   f   2.43
                                                           Author                                rank   g   2.38
                                                           Content (the information that a
                                                           document contains)                    rank   i   4.75

                                                           Type (requirements,
                                                           specification, detailed design,
                                                           architectural document)               rank   j   3.75
                                                           Influence from management /
                                                           project leaders / other
                                                           developers to use it                  rank   k   2.29
                                                           Spelling and grammar                  rank   l   3.13
                                                           Writing Style (choice of words,
                                                           sentence and paragraph
                                                           structure)                            rank   m   3.50

                                                           Extent to which it is up-to-date      rank   n   4.29
                                                           Use of modelling diagrams
                                                           (UML, SDL, etc)                       rank   o   3.25
                                                           Use of examples (how to
                                                           extend or customize a
                                                           feature).                             rank   p   4.13
How relevant are the following factors in causing
software documentation to be out of sync with the
system it describes. Rate between one (1) as a
completely IRRELEVANT factor and five (5) as an               Time constraints on
extremely RELEVANT factor                                     developers                       12 rank      a   4.00
                                                              Budget constraints on the
                                                              project                             rank      b   3.25
                                                              High costs of maintaining
                                                              documentation is not worth the
                                                              effort                              rank      c   3.25
                                                              Rapid changes in
                                                              requirements                        rank      d   3.75
                                                              Rapid staff turnover                rank      e   2.86

                                                              Team members do not believe
                                                              in documenting their code           rank      f   4.25
                                                              Team members are
                                                              unmotivated to document their
                                                              code                                rank      g   4.25
                                                              Team members see little
                                                              benefit in always maintaining
                                                              supporting documents                rank      h   3.75
If software documentation could be graded (based on
several factors such as appropriate length, readability,
accuracy, ease of use, and the extent to which it is up to
date) then it might be more useful to me.
                                                                                               13 opinion       3.31
Software documentation is important, but in my
organization it is unfortunately not that useful.                                              14 opinion       2.41
Software documentation that I reference is easy to
understand, navigate and cross reference.                                                      15 opinion       3.06
The language / style of writing in software documentation
I reference is brief and to the point.                                                         16 opinion       2.94
When I am working on a software system and require
assistance, it is easy to locate the appropriate supporting
documentation.                                                                                 17 opinion       2.82
Tools to view and browse software documents are bulky
and inefficient.                                                                               18 opinion       2.88
Tools to view and browse software documents facilitate
my work.                                                                                       19 opinion       3.69
Documentation is always outdated relative to the current
state of a software system.                                                                    20 opinion       3.06
Software documentation can be useful even through it
might not always be the most up to date (relative the
system it documents).                                                                          21 opinion       4.06
Most software documents have a finite useful lifetime
and should be subsequently discarded (or removed from
the primary document repository).                                                              22 opinion       2.82
The cost of maintaining most software documents
greatly outweighs the benefits of having such documents
up to date.                                                                                    23 opinion       2.12
Software documentation contains a lot of information that
can be extracted directly from the system’s source code
itself.                                                                                        24 opinion       2.94
Tools that help extract information from source code (for
example JavaDoc) are extremely powerful for creating
supporting documentation.                                                                      25 opinion       3.19
Software documentation concentrates too heavily on
high level issues rather than the important
implementation details.                                      26 opinion         2.63
Software documentation that I have found useful during
inception / construction of a system differs from that
which I find useful during maintenance and testing of that
system.                                                      27 opinion         3.65
Much more effort is required to format / prepare software
documentation than the effort of providing the actual
content for the documents.                                   28 opinion         2.53
I practice (or am trying to practice) agile software
(agilemanifesto.org) techniques (i.e. eXtreme
Programming (extremeprogramming.org) and Test First
programming) and believe in the effectiveness of unit
testing.                                                     29 opinion         1.63
Automated testing (such as J-Unit) helps exhibit the true
state of a system and is a useful tool for software
documentation.                                               30 opinion         2.91
It would be useful to have tools to track changes in a
software system for the purpose of updating and
maintaining its supporting documentation.                    31 opinion         4.38
I would rather refactor / update / debug / test a system
then document it in its present (and flawed) state.
                                                             32 opinion         3.14
We use a useful configuration management system to
maintain our software documentation.                         33 opinion         2.94
Software documentation (i.e. the collection of documents
describing a particular system) that I reference is poorly
organized and difficult to navigate primarily due to the
size and number of the documents available.
                                                             34 opinion         3.41
Only a few software documents are personally useful to
me.                                                          35 opinion         3.38
Which software tools do you find MOST helpful to create
/ edit / browse / generate software documentation? (For
example, text editors, word processors, spreadsheets,
JavaDoc).




                                                             36 textarea   #DIV/0!
Which software tools do you find LEAST helpful to create
/ edit / browse / generate software documentation?




                                                                                           37 textarea       #DIV/0!
Relative to past projects, please compare the amount of
documentation being produced in your current project
compared to the amount of software delivered (i.e.. lines
of code, features developed, etc). Rate between one (1)
as extremely LESS documentation and five (5) as
extremely MORE documentation.
                                                            Requirements                   38 rank       a        2.86
                                                            Specifications                    rank       b        2.86
                                                            Detailed Design                   rank       c        2.86
                                                            Low Level Design                  rank       d        2.67
                                                            Architectural                     rank       e        3.29
                                                         Testing / Quality Documents          rank       f        3.29
Relative to past projects, please compare the quality of
the software of your current project. Rate between one
(1) for much LOWER quality and five (5) much HIGHER
quality.                                                 # Defects per line of code.       39 rank       a        3.17
                                                         Team members' pride in
                                                         project                              rank       b        3.29
                                                         Manager's satisfaction with the
                                                         projects progress                    rank       c        3.29
                                                            Customer Satisfaction             rank       d        3.83
                                                            Project delivery on time          rank       e        3.43
                                                         Project delivery on budget             rank       f              3.29
Relative to past projects, please compare the quality of
the documentation of your current project. Rate between Maintenance (Is is easier to
one (1) for much LOWER quality and five (5) much         keep the documents up to
HIGHER quality.                                          date?)                              40 rank       a              3.17
                                                         Writing style (Is it easier to
                                                         read and understand?)                  rank       b              3.50

                                                           Navigation (Is it easier to
                                                           move between documents?)             rank       c              3.83

                                                           Searching (Is it easier to find
                                                           the information you need?)           rank       d              3.50
                                                           Updated (Are the documents
                                                           more up to date?)                    rank       e              3.50
What is the size of your current (or recently completed)   < 1 KLOC (KLOC = 1000 lines
project in KLOCS.                                          of code)                          41 radio      a    --
                                                           between 1 and 5 KLOCS                radio      b    --
                                                           between 5 – 20 KLOCS                 radio      c    --
                                                           between 20 – 50 KLOCS                radio      d    --
                                                           between 50 – 100 KLOCS               radio      e    --
                                                           over 100 KLOCS                       radio      f    --
                                                           N/A                                  radio      na   --
How long have you been working in the software field?
                                                           < 1 year                          42 radio      a    --
                                                           1 - 4 years                          radio      b    --
                                                           5-10 years                           radio      c    --
                                                           > 10 years                           radio      d    --
What type of products / services does your company
offer?




                                                                                             43 textarea             #DIV/0!
What is / are your current job function(s)?                Manager                           44 checkbox   a    --
                                                           Project Leader                       checkbox   b    --
                                                           Software Architects.                 checkbox   c    --
                                                           Sr. Software Developer               checkbox   d    --
                                                           Jr. Software Developers              checkbox   e    --
                                                           Technical Writers                    checkbox   f    --
                                                           Software Support                     checkbox   g    --
                                                           Quality Assurance                    checkbox   h    --
                                                           Student                              checkbox   i    --
                                                           Other                                checkbox   j    --
                                                           None of the above                    checkbox   k    --
What are some past job functions you have held?            Manager                           45 checkbox   a    --
                                                           Project Leader                       checkbox   b    --
                                                           Software Architects.                 checkbox   c    --
                                                           Sr. Software Developer               checkbox   d    --
                                                           Jr. Software Developers              checkbox   e    --
                                                           Technical Writers                    checkbox   f    --
                                                           Software Support                     checkbox   g    --
                                                           Quality Assurance                    checkbox   h    --
                                                         None of the above                    checkbox   k   --
What type of development process(es) does your
company / manager recommend?                             No defined process                46 checkbox   a   --
                                                         Waterfall model                      checkbox   b   --
                                                         Incremental model                    checkbox   c   --
                                                         Iterative model                      checkbox   d   --
                                                         Agile process                        checkbox   e   --
                                                         Test first strategies                checkbox   f   --
                                                         Rational unified process             checkbox   g   --
                                                         Personal software process            checkbox   h   --
                                                         Clean Room Approach                  checkbox   i   --
                                                         Code and Debug                       checkbox   j   --
                                                         Internal Process                     checkbox   k   --
                                                         Other                                checkbox   l   --
                                                         N/A                                  checkbox   m   --
To what extent does your software team do the following
activities. This list is described by Joel Spolsky as The
Joel Test. More information is available online at
joelonsoftware.com. Rate between one (1) for NEVER
and five (5) for ALWAYS.                                  Use source control (ie. CVS
                                                          system)                          48 rank       a        4.50
                                                         Have daily builds                    rank       b        3.29
                                                         Maintain a bug database              rank       c        4.50
                                                         Fix bugs before writing new
                                                         code                                 rank       d        3.25

                                                         Keep an up-to-date schedule          rank       e        3.43
                                                         Have a specifications
                                                         document for your project            rank       f        3.13
                                                         Have new candidates for the
                                                         development team write code
                                                         during the interview                 rank       h        1.57
                                                         Have testers                         rank       j        3.75
                                                         Conduct hallway usability tests
                                                         (ie. Grab someone from the
                                                         hallway to try the newly added
                                                         feature)                             rank       k        1.88
Std Dev          Mode       Median         Max       Min       Count        Percentage   128   162




--               --         --             --        --                10        58.8%    1     1
--               --         --             --        --                13        76.5%    1     1
--               --         --             --        --                10        58.8%    1
--               --         --             --        --                8         47.1%    1
--               --         --             --        --                9         52.9%    1
--               --         --             --        --                9         52.9%          1




          1.07          1             2          4         1           8 --                     1
          0.93          3             3          5         2           8 --                     3
          0.00          3             3          3         3           8 --                     3
          0.82          3            3.5         5         3           6 --                     4
          0.53          3             3          4         2           8 --                     3
          0.84          4             4          4         2           6 --                     2




          1.39          1             2          5         1           8 --                     1
          1.06          3            2.5         4         1           8 --                     1
          0.71          3             3          4         2           8 --                     4
          1.21          4             3          4         1           7 --                     4
          0.99          3             3          4         1           8 --                     3
          1.41          3             3          5         1           6 --                     1




          1.16          2             2          5         2           8 --                     2
          1.16          4            3.5         5         2           8 --                     4
          1.25          4             4          5         2           8 --                     2
          1.13          4             4          5         2           7 --                     2
          1.16          5            3.5         5         2           8 --                     5
0.89   5   4.5   5   3   8 --   5




1.51   4   3.5   5   1   8 --   2
1.19   3    3    5   2   8 --   4
1.19   3   3.5   5   1   8 --   3
0.98   3    3    5   2   7 --   3
0.99   4    4    5   2   8 --   4
0.53   4   4.5   5   4   8 --   4




1.39   4    4    5   1   8 --   4
1.19   5    5    5   2   8 --   5
1.41   5    5    5   2   8 --   3
1.00   2    3    4   2   7 --   2
0.76   4    4    5   3   8 --   4
1.31   4    4    5   1   8 --   4




1.19   4    4    5   2   8 --   2

0.90   4    3    4   2   7 --   2

1.30   2   3.5   5   2   8 --   2


1.38   4    4    5   1   7 --   2




1.46   3    3    5   1   7 --   2


1.19   3    3    5   2   8 --   4


1.28   5    4    5   2   8 --   2

1.07   4    4    5   2   8 --   3


1.41   3   3.5   5   1   8 --   3




0.92   4    4    5   2   8 --   3

1.28   2    3    5   2   8 --   2
1.46          2   2.5   5   1   8 --   2




1.71   #N/A       2.5   5   1   4 --   1

1.22          4    4    5   2   6 --   5




0.92          3    3    5   2   8 --   3


0.83          4    4    5   3   8 --   3


0.76          4    4    5   3   8 --   3


1.06          4   3.5   5   2   8 --   3




0.93          3   3.5   5   2   8 --   3


0.98          2    2    4   1   7 --   2
1.51          1    2    5   1   8 --   2

0.46          5    5    5   4   8 --   5




1.04          4    4    5   2   8 --   5


0.76          2    2    3   1   7 --   2
0.64          3    3    4   2   8 --   2


0.93          3   3.5   5   2   8 --   3

0.76          4    4    5   3   7 --   4

1.04          3    3    5   2   8 --   4


0.64          4    4    5   3   8 --   4
1.07   4    4    5   2    8 --       4

1.04   3    3    5   2    8 --       4


1.04   3    3    5   2    8 --       3

1.28   4    4    5   1    8 --       4
1.46   2    2    5   2    7 --       2


1.16   5    5    5   2    8 --       5


1.49   5    5    5   1    8 --       5



1.58   5   4.5   5   1    8 --       5




1.40   5   3.5   5   1   16 --   3   3

1.54   1    2    5   1   17 --   4   5

1.39   4    4    5   1   17 --   4   1

1.03   2    2    4   2   17 --   4   2


1.13   2    2    5   1   17 --   3   2

1.02   3    3    5   1   16 --   5   3

0.79   4    4    5   2   16 --   4   2

1.29   4    4    5   1   16 --   4   2


0.90   4    4    5   2   17 --   4   4


1.33   2    2    5   1   17 --   5   4


1.36   1    2    5   1   17 --   2   1


1.52   2    2    5   1   17 --   4   1


1.17   4    3    5   1   16 --   5   2
     0.96          2            2    4   1   16 --              2            2




     1.46          5            4    5   1   17 --              5            2


     1.46          4            2    5   1   17 --              4            2




     0.52          2            2    2   1    8 --   na                      1


     1.04          4            3    4   1   11 --              3            2


     1.02          5            5    5   1   16 --              5            4


     1.17          4           3.5   5   1   14 --              4            4

     1.44          4            4    5   1   16 --              5            4




     1.33          4            4    5   1   17 --              4            4

     1.20          4            4    5   1   16 --              4            4




#DIV/0!     #N/A       #NUM!         0   0    0 --                word processor, database system
                                                     JavaDoc Rational Rose
#DIV/0!     #N/A       #NUM!         0   0   0 --   Word Acrobat word processor




     1.77          1            2    5   1   7 --                          1
     1.57          1            3    5   1   7 --                          1
     1.57          4            3    5   1   7 --                          2
     1.63          1           2.5   5   1   6 --                          1
     1.25          3            3    5   1   7 --                          3
     1.50          3            3    5   1   7 --                          3




     0.75          3            3    4   2   6 --                          2

     0.95          3            3    5   2   7 --                          3

     0.49          3            3    4   3   7 --                          3
     0.75          4            4    5   3   6 --                          4
     1.27          2            3    5   2   7 --                          2
          0.95               3                 3         5        2   7 --                                      3




          1.33               2                 3         5        2   6 --                                      2

          1.38               4                 4         5        1   6 --                                      1


          0.75               4                 4         5        3   6 --                                      3


          1.05               4                3.5        5        2   6 --                                      2

          1.38               4                 4         5        1   6 --                                      1

--               --              --                 --       --       0      0.0%
--               --              --                 --       --       0      0.0%
--               --              --                 --       --       4      23.5%
--               --              --                 --       --       3      17.6%
--               --              --                 --       --       2      11.8%               1              1
--               --              --                 --       --       1      5.9%
--               --              --                 --       --       6      35.3%

--               --              --                 --       --       0      0.0%
--               --              --                 --       --       3      17.6%
--               --              --                 --       --       7      41.2%                              1
--               --              --                 --       --       7      41.2%               1




     #DIV/0!          #N/A            #NUM!              0        0   0 --                         Point-of-Sale systems written in Java
                                                                                     A unique software integration toolkit in one of my lives, an
--               --              --                 --       --       4      23.5%               1
--               --              --                 --       --       3      17.6%
--               --              --                 --       --       4      23.5%               1
--               --              --                 --       --       3      17.6%
--               --              --                 --       --       0      0.0%
--               --              --                 --       --       8      47.1%
--               --              --                 --       --       1      5.9%
--               --              --                 --       --       3      17.6%                              1
--               --              --                 --       --       0      0.0%
--               --              --                 --       --       1      5.9%
--               --              --                 --       --       2      11.8%
--               --              --                 --       --       4      23.5%                              1
--               --              --                 --       --       7      41.2%               1              1
--               --              --                 --       --       0      0.0%
--               --              --                 --       --       8      47.1%               1              1
--               --              --                 --       --       8      47.1%               1
--               --              --                 --       --       7      41.2%
--               --              --                 --       --       5      29.4%
--               --              --                 --       --       6      35.3%                              1
--          --       --         --       --       1      5.9%

--          --       --         --       --       1      5.9%        1
--          --       --         --       --       4      23.5%   1
--          --       --         --       --       4      23.5%       1
--          --       --         --       --       4      23.5%
--          --       --         --       --       1      5.9%
--          --       --         --       --       2      11.8%
--          --       --         --       --       1      5.9%
--          --       --         --       --       0      0.0%
--          --       --         --       --       0      0.0%
--          --       --         --       --       3      17.6%       1
--          --       --         --       --       7      41.2%   1
--          --       --         --       --       2      11.8%   1
--          --       --         --       --       1      5.9%




     1.07        5         5         5        2   8 --               5
     1.25        3         3         5        2   7 --               2
     0.53        5        4.5        5        4   8 --               5

     0.89        3         3         5        2   8 --               3

     1.40        4         4         5        1   7 --               1

     1.55        2         3         5        1   8 --               2


     0.53        2         2         2        1   7 --               1
     1.58        5        4.5        5        1   8 --               5




     0.83        2         2         3        1   8 --               3
178   181   182        183        187   201     205   212   217




 1     1      1                    1
 1     1      1         1          1     1       1
 1     1      1                    1     1
 1     1                1          1             1
 1     1      1         1          1
       1                           1     1




       1                1          2     2       4
       5                2          2     3       3
       3                3          3     3       3
       5                3          3     4 na
       4                3          3     3       2
       4          na         na          4       4




       5                2          1     2       1
       2                3          1     2       3
       3                4          2     3       3
       3                4          2     2       1
       3                4          2     3       1
       5          na         na          2       3




       2                3          2     2       4
       2                4          2     3       4
       4                5          2     5       4
       4                5          2     4       4
       3                5          2     3       4
5   5      4   3      4




5   1      1   4      4
5   3      2   5      3
5   4      1   3      3
5   3      2   3      4
5   2      3   4      4
5   4      4   4      5




4   2      1   4      2
5   3      2   5      5
5   2      2   5      5
4   2      2   3      4
4   3      3   4      4
4   5      4   4      1




5   4      2   5      4

2   3 na       4      3

2   5      2   4      5



3   4      1   4      4




3   5      1   3 na



5   3      2   3      3



3   5      2   5      5

4   5      2   5      5



4   2      1   4      3




4   4      3   4      4

2   4      2   3      5
     2   2   1   3   5




na       3           2

     4   2       4   2




     3   4   4   2   3



     4   4   5   5   4



     4   3   4   5   4



     4   4   4   5   2




     4   3   4   5   4



     3   1   2   4   3
     2   1   4   3   1

     5   5   5   5   4




     4   4   2   3   4



     3   1   2   3   2
     4   3   3   3   3



     4   3   3   4   2

         4   5   5   5

     3   2   3   5   3



     4   4   4   5   3
         2       5   3   5   5

         2       2   3   5   3



         2       3   5   4   4

         5       4   4   3   5
         5       2   2   5   2



         5       5   5   4   5



         5       5   5   5   5



         5       5   5   4   3




     2   5   2   1   5   4   3   4   1

     1   4   4   1   5   2   1   4   2

     5   4   2   3   1   4   2   4   1

     4   2   4   4   2   2   2   2   2



     2   2   1   4   2   2   4   2   3

na       3   3   2   3   3   4   2   1

na       4   4   3   3   4   3   4   5

         4   4   2   5   4   4   4   1



     5   4   4   4   4   5   5   4   4



     2   2   2   2   2   4   2   2   5



     1   2   1   2   1   5   1   2   5



     5   1   2   2   2   5   4   2   5



     4   2   2   3   2   3   4   4   5
            2             4             2              3             2             4              2             2             4




            5             5             4              4             4             5              2             4             5



            1             5             1              4             2             4              1             1             1




            1 na                        2              2 na              na                       2             2 na



            1 na                        3              2 na                        4 na                         4 na



            4             5             4              4             5             5              5             4             1



            4             4             3              2 na              na                       2             2             4

            1             1             1              4             2             4              1             4             2




            1             5             4              3             4             4              5             4             1

            4             2             4              3             4 na                         5             4             2




               Word, framemaker, excel, visio, & publishing tools needed;to put docs,what theywe creating content JavaDoc,
                              Word processors textpad, also a good place otherwise, Word browsers/help by some class Tools processors reading the sou
                                              Obviously, homesite, robohelp            and are can be
                                                                                                    Proprietary Reviewing browsers software
                                                                                                                  with? Usually,
text editor on html. class description texts (python) areeditors are such as FrameMaker, web processorsreadviewers, Acrobat word the or just by product being d
word processor                Spreadsheets,Inflexible compilers
                                            text editors                          Spreadsheets
                 javadoc nobody seems to know how to use it !!! (such as MS HTML Workshop) are my bane. Tools that are non-cross-platform and proprietary




                            5                          2             1            5
                            5                          3             1            4
                            5                          4             1            3
                            5                          4             1            3
                            5                          3             1            4
                            5                          3             1            5




                            4                          4             3 na

                            5                          3             3            4

                            4                          3             3            4
                            5                          4             3 na
                            5                          2             3            4
                         5                           2             3             4




                         5                           4 na                        2

                         5                           4 na                        4



                         5                           4 na                        4



                         5                           4 na                        3

                         5                           4 na                        3




                                       1             1                                                                     1
                         1                                                       1


                                                                                                             1
           1                                                                                   1



                         1
           1                                         1             1             1             1
                                       1                                                                     1             1




            Everything but system transactionnal websites, hardwaredatabase management, care and billing mainframe services plus
                           mostly       Graphics, document editing, NPU, lookup Customer office engines
                                                                                               C/C++ software, & Class Libraries
                                                                                                             Development tools
OSS automation and controlTelecommunication software andfinancial/banking apps and classification suiteCompilers desktop publishing. ancilliary software p
                                                                                                             1
           1                           1                                                                                   1
           1                           1
           1                           1


           1             1             1             1             1             1             1
                         1
                         1


                                       1


                                       1
                                       1                                                                     1             1


           1                           1                                                                     1             1
                                       1             1                                                       1             1
                         1             1             1                           1             1
                         1                                         1                           1
                         1                           1                                         1                           1
        1                      1
1
        1


                    1
        1



                1          1
        1   1              1       1




    5       5   5   5      5
    5       3   2   3      3
    5       5   4   5      4

    3       4   3   5      2

            4   2   5      4

    5       2   1   5      4



    2       2   2   2 na
    2       5   3   4      5




    2       2   3   1      2
232   248   251   10   16   20




 1     1      1        1
 1     1      1        1
 1     1      1        1
              1        1
 1            1        1
 1     1      1        1    1




 3                     2
 3                     3
 3                     3
                       3
 3                     3
 3                     4




 3                     3
 3                     4
 3                     4
                       4
 3                     4
 3                     4




 5                     2
 5                     2
 5                     4
                       4
 5                     3
     5   3




     4   3
     2   3
     4   4
         4
     5   4
     5   5



     5   4
     5   5
     5   5
         4
     5   5
     5   5




     4   3

     4   4

     3   4


na       5




     5   3


     5   2


     4   4

     4   4


     5   5




     5   2

     5   3
     5        3



     5   na

na            4




     5        3


     5        3


     4        5


     3        2



     3        2


              2
     5        1

     5        4



     5        3


na            3
     4        3


     5        4

     4        3

     4        2


     5        4
     4               4

     4               3


     3               2

     1               4
na                   2


     3               2


     3               1


     2               1




     5   4   5       2   4

     1   1   2   2   1   1

     2   5   2   4   4   4

     4   4   2   2   4   4


     4   5   2   4   2   4

     4   2   3   2   2   4

     5   4   3   4   3   4

     1   2   2   4   2   4


     5   4   2   2   5   4


     1   2   4   1   4   4


     1   1   2   3   2   4


     5   2   3   2   1   4


na       4   3   3   1   4
          1 na                  3              3            2    4



          1      1              2              4            5    4


          4      1              2              2            4    4




          1 na       na             na             na            2


na               4              2   na                      4    3


          5      4                             5            5    5


          5      2              4   na                      1    3

          2      4              4   na                      4    4




          4      2              4              4            1    4

          2      2              4              4            1    5




                                                   Document
                                                   ation tools
                                                   (such as
                                                   FrameMa
                                                   ker and
                                                   Author-
                                                   IT). These
                                                   are in a
                                                   class
                     We have                       distinct
                     standard                      from word
                     templates in                  processor
                     various word
                                    Word           s such as
                     processing
We only use          formats. I     Visio          Word and
Microsoft            use MS         Rational       WordPerf
Word        -        Word.          Rose           ect.
                Document
                ation
                extraction
We only use     tools,
Microsoft       such as
Word        -   Javadoc.




          4              2
          4              2
          4              1
                         2
          4              3
          4              2



          3              3

          3              2

          3              3
          3              4
          3              5
           3                                                 3



           4                                                 2

           3                                                 4


           3                                                 4


           4                                                 3

           4                                                 4



                                      1
           1



                   1                            1            1   1


                   1                                             1
                                                             1
           1                          1         1

                                        XML-
                       Database         based
                       and related
                                        email plug-
                       applications
                       (products,       in Email
                       support,         marketing
Aircraft       -       consulting)      services Financial
                                      1          1

           1
                   1


                                                             1

                                                                 1


                   1                            1
                                      1         1
                                      1                      1

           1                          1
                   1                  1                      1
                                                1            1
                   1                                         1
                                                             1
                         1


     1
     1   1
     1   1           1
     1
                         1




             1   1
                         1
         1




     4               2
na                   5
     4               4

     3               3

     4               4

     4               2


     1               1
     1               5



     1               1
Question                                               Options                         QID     Type       Letter       128
In your experience, who has the prime
RESPONSIBILITY to CREATE and MAINTAIN the
following types of software documentation?<br>
Select 1: Customer(s) / Client(s).<br>
Select 2: Manager / Project Leader.<br>
Select 3: Software Architects. / Sr. Developers.<br>
Select 4: Jr. Developers.<br>
Select 5: Technical Writers.<br>
                                                       Requirements                          2 rank       a
                                                                                0.38    0.38          1            3
                                                                                0.38    0.38          2            3
                                                                                0.13    0.13          3            1
                                                                                0.13    0.13          4            1
                                                                                0.00    0.00          5            0
                                                                                0.00    0.00 na                    0
                                                       Specifications                          rank       b
                                                                                0.00    0.00          1            0
                                                                                0.25    0.25          2            2
                                                                                0.63    0.63          3            5
                                                                                0.00    0.00          4            0
                                                                                0.13    0.13          5            1
                                                                                0.00    0.00 na                    0
                                                       Detailed Design                         rank       c
                                                                                0.00    0.00          1            0
                                                                                0.00    0.00          2            0
                                                                                1.00    1.00          3            8
                                                                                0.00    0.00          4            0
                                                                                0.00    0.00          5            0
                                                                                0.00    0.00 na                    0
                                                       Low Level Design                        rank       d
                                                                                0.00    0.00          1            0
                                                                                0.00    0.00          2            0
                                                                                0.50    0.43          3            3
                                                                                0.33    0.29          4            2
                                                                                0.17    0.14          5            1
                                                                                0.17    0.14 na                    1
                                                       Architectural                           rank       e
                                                                                0.00    0.00          1            0
                                                                                0.13    0.13          2            1
                                                                                0.75    0.75          3            6
                                                                                0.13    0.13          4            1
                                                                                0.00    0.00          5            0
                                                                                0.00    0.00 na                    0
                                                       Testing / Quality Documents             rank       f
                                                                                0.00    0.00          1            0
                                                                                0.17    0.13          2            1
                                                                                0.17    0.13          3            1
                                                                                0.67    0.50          4            4
                                                                                0.00    0.00          5            0
                                                                                0.33    0.25 na                    2
In your experience, who has the prime
RESPONSIBILITY to VERIFY and VALIDATE the
information in the following types of software
documentation?<br>
Select 1: Customer(s) / Client(s).<br>
Select 2: Manager / Project Leader.<br>
Select 3: Software Architects.<br>
Select 4: Developers.<br>
Select 5: Technical Writers.<br>
                                                 Requirements                      3 rank          a
                                                                          0.38   0.38          1       3
                                                                          0.25   0.25          2       2
                                                                          0.25   0.25          3       2
                                                                          0.00   0.00          4       0
                                                                          0.13   0.13          5       1
                                                                          0.00   0.00 na               0
                                                 Specifications                         rank       b
                                                                          0.25   0.25          1       2
                                                                          0.25   0.25          2       2
                                                                          0.38   0.38          3       3
                                                                          0.13   0.13          4       1
                                                                          0.00   0.00          5       0
                                                                          0.00   0.00 na               0
                                                 Detailed Design                        rank       c
                                                                          0.00   0.00          1       0
                                                                          0.13   0.13          2       1
                                                                          0.50   0.50          3       4
                                                                          0.38   0.38          4       3
                                                                          0.00   0.00          5       0
                                                                          0.00   0.00 na               0
                                                 Low Level Design                       rank       d
                                                                          0.14   0.14          1       1
                                                                          0.29   0.29          2       2
                                                                          0.14   0.14          3       1
                                                                          0.43   0.43          4       3
                                                                          0.00   0.00          5       0
                                                                          0.00   0.00 na               0
                                                 Architectural                          rank       e
                                                                          0.13   0.13          1       1
                                                                          0.13   0.13          2       1
                                                                          0.50   0.50          3       4
                                                                          0.25   0.25          4       2
                                                                          0.00   0.00          5       0
                                                                          0.00   0.00 na               0
                                                 Testing / Quality Documents            rank       f
                                                                          0.17   0.13          1       1
                                                                          0.17   0.13          2       1
                                                                          0.33   0.25          3       2
                                                                          0.17   0.13          4       1
                                                                          0.17   0.13          5       1
                                                                          0.33   0.25 na               2
In your experience, when changes are made to a
software system, how long does it take for the supporting
documentation to be updated to reflect such
changes?<br>
Rate 1: Updates are NEVER made.<br>
Rate 2: Updates are RARELY made.<br>
Rate 3: Updates are made within a few MONTH of the
changes.<br>
Rate 4: Updates are made within a few WEEKS of the
changes.<br>
Rate 5: Updates are made within a few DAYS of the
changes.<br>
                                                            Requirements                      4 rank          a
                                                                                     0.00   0.00          1       0
                                                                                     0.63   0.63          2       5
                                                                                     0.13   0.13          3       1
                                                                                     0.13   0.13          4       1
                                                                                     0.13   0.13          5       1
                                                                                     0.00   0.00 na               0
                                                            Specifications                         rank       b
                                                                                     0.00   0.00          1       0
                                                                                     0.38   0.38          2       3
                                                                                     0.13   0.13          3       1
                                                                                     0.38   0.38          4       3
                                                                                     0.13   0.13          5       1
                                                                                     0.00   0.00 na               0
                                                            Detailed Design                        rank       c
                                                                                     0.00   0.00          1       0
                                                                                     0.25   0.25          2       2
                                                                                     0.00   0.00          3       0
                                                                                     0.38   0.38          4       3
                                                                                     0.38   0.38          5       3
                                                                                     0.00   0.00 na               0
                                                            Low Level Design                       rank       d
                                                                                     0.00   0.00          1       0
                                                                                     0.29   0.29          2       2
                                                                                     0.00   0.00          3       0
                                                                                     0.57   0.57          4       4
                                                                                     0.14   0.14          5       1
                                                                                     0.00   0.00 na               0
                                                            Architectural                          rank       e
                                                                                     0.00   0.00          1       0
                                                                                     0.13   0.13          2       1
                                                                                     0.38   0.38          3       3
                                                                                     0.13   0.13          4       1
                                                                                     0.38   0.38          5       3
                                                                                     0.00   0.00 na               0
                                                            Testing / Quality Documents            rank       f
                                                                                     0.00   0.00          1       0
                                                                                     0.00   0.00          2       0
                                                                                     0.25   0.25          3       2
                                                                                     0.25   0.25          4       2
                                                                                     0.50   0.50          5       4
                                                                                     0.00   0.00 na               0
In your experience, how effective are the following types
of software documents in reflecting the true state of a
software system. Rate between one (1) as completely
USELESS and five (5) as extremely EFFECTIVE.
                                                            Requirements                      5 rank          a
                                                                                     0.25   0.25          1       2
                                                                                     0.13   0.13          2       1
                                                                                     0.13   0.13          3       1
                                                                                     0.38   0.38          4       3
                                                                                     0.13   0.13          5       1
                                                                                     0.00   0.00 na               0
                                                            Specifications                         rank       b
                                                                                     0.00   0.00          1       0
                                                                                     0.25   0.25          2       2
                                                                                     0.38   0.38          3       3
                                                                                     0.13   0.13          4       1
                                                                                     0.25   0.25          5       2
                                                                                     0.00   0.00 na               0
                                                            Detailed Design                        rank       c
                                                                                     0.13   0.13          1       1
                                                                                     0.00   0.00          2       0
                                                                                     0.38   0.38          3       3
                                                                                     0.38   0.38          4       3
                                                                                     0.13   0.13          5       1
                                                                                     0.00   0.00 na               0
                                                            Low Level Design                       rank       d
                                                                                     0.00   0.00          1       0
                                                                                     0.14   0.14          2       1
                                                                                     0.43   0.43          3       3
                                                                                     0.29   0.29          4       2
                                                                                     0.14   0.14          5       1
                                                                                     0.00   0.00 na               0
                                                            Architectural                          rank       e
                                                                                     0.00   0.00          1       0
                                                                                     0.13   0.13          2       1
                                                                                     0.13   0.13          3       1
                                                                                     0.50   0.50          4       4
                                                                                     0.25   0.25          5       2
                                                                                     0.00   0.00 na               0
                                                            Testing / Quality Documents            rank       f
                                                                                     0.00   0.00          1       0
                                                                                     0.00   0.00          2       0
                                                                                     0.00   0.00          3       0
                                                                                     0.50   0.50          4       4
                                                                                     0.50   0.50          5       4
                                                                                     0.00   0.00 na               0
In your experience, how often do you consult the
available software documentation when working on that
software system? Rate between one (1) as NEVER and
five (5) as ALWAYS.                                         Requirements                      6 rank          a
                                                                                     0.13   0.13          1       1
                                                                                     0.25   0.25          2       2
                                                                                     0.00   0.00          3       0
                                                                              0.50   0.50          4       4
                                                                              0.13   0.13          5       1
                                                                              0.00   0.00 na               0
                                                     Specifications                         rank       b
                                                                              0.00   0.00          1       0
                                                                              0.13   0.13          2       1
                                                                              0.13   0.13          3       1
                                                                              0.00   0.00          4       0
                                                                              0.75   0.75          5       6
                                                                              0.00   0.00 na               0
                                                     Detailed Design                        rank       c
                                                                              0.00   0.00          1       0
                                                                              0.25   0.25          2       2
                                                                              0.13   0.13          3       1
                                                                              0.00   0.00          4       0
                                                                              0.63   0.63          5       5
                                                                              0.00   0.00 na               0
                                                     Low Level Design                       rank       d
                                                                              0.00   0.00          1       0
                                                                              0.43   0.43          2       3
                                                                              0.14   0.14          3       1
                                                                              0.43   0.43          4       3
                                                                              0.00   0.00          5       0
                                                                              0.00   0.00 na               0
                                                     Architectural                          rank       e
                                                                              0.00   0.00          1       0
                                                                              0.00   0.00          2       0
                                                                              0.25   0.25          3       2
                                                                              0.50   0.50          4       4
                                                                              0.25   0.25          5       2
                                                                              0.00   0.00 na               0
                                                     Testing / Quality Documents            rank       f
                                                                              0.13   0.13          1       1
                                                                              0.00   0.00          2       0
                                                                              0.00   0.00          3       0
                                                                              0.50   0.50          4       4
                                                                              0.38   0.38          5       3
                                                                              0.00   0.00 na               0
In your experience, how effective do you find the
available software documentation for a software project
in the following circumstances. Rate between one (1) as
completely USELESS and five (5) as extremely            When LEARNING a software
EFFECTIVE.                                              system.                        7 rank          a
                                                                              0.00   0.00          1       0
                                                                              0.25   0.25          2       2
                                                                              0.13   0.13          3       1
                                                                              0.38   0.38          4       3
                                                                              0.25   0.25          5       2
                                                                              0.00   0.00 na               0
                                                     When MAINTAINING a
                                                     software system.                       rank       b
                                                                              0.00   0.00          1       0
                                                                              0.29   0.25          2       2
                          0.29   0.25          3       2
                          0.43   0.38          4       3
                          0.00   0.00          5       0
                      0.14       0.13 na               1
When TESTING a software
system.                                 rank       c
                          0.00   0.00          1       0
                          0.38   0.38          2       3
                          0.13   0.13          3       1
                          0.25   0.25          4       2
                          0.25   0.25          5       2
                          0.00   0.00 na               0
When other developers are
UNAVAILABLE to answer my
questions.                              rank       d
                          0.14   0.13          1       1
                          0.14   0.13          2       1
                          0.14   0.13          3       1
                          0.43   0.38          4       3
                          0.14   0.13          5       1
                          0.14   0.13 na               1

When explaining / answering
questions about the system to
MANAGEMENT or
CUSTOMERS.                              rank       f
                          0.14   0.13          1       1
                          0.14   0.13          2       1
                          0.43   0.38          3       3
                          0.00   0.00          4       0
                          0.29   0.25          5       2
                          0.14   0.13 na               1
When looking for BIG-
PICTURE information about
the software system                     rank       g
                          0.00   0.00          1       0
                          0.25   0.25          2       2
                          0.38   0.38          3       3
                          0.13   0.13          4       1
                          0.25   0.25          5       2
                          0.00   0.00 na               0
When looking for IN-DEPTH
information about the software
system.                                 rank       h
                          0.00   0.00          1       0
                          0.25   0.25          2       2
                          0.13   0.13          3       1
                          0.25   0.25          4       2
                          0.38   0.38          5       3
                       0.00      0.00 na               0
When working with a NEW
software system                         rank       i
                          0.00   0.00          1       0
                          0.13   0.13          2       1
                                                                                         0.13   0.13          3       1
                                                                                         0.38   0.38          4       3
                                                                                         0.38   0.38          5       3
                                                                                         0.00   0.00 na               0
                                                              When working with an
                                                              ESTABLISHED / MATURE
                                                              software systems                         rank       j
                                                                                         0.13   0.13          1       1
                                                                                         0.13   0.13          2       1
                                                                                         0.25   0.25          3       2
                                                                                         0.25   0.25          4       2
                                                                                         0.25   0.25          5       2
                                                                                         0.00   0.00 na               0
In your experience, how well maintained is supporting
software documentation in the following type of software
projects (please note, we are referring to both the quality
and frequency of the updates). Rate between one (1) as
NOT MAINTAINED at all and rate five (5) as extremely
WELL MAINTAINED.
                                                              New or recent projects              8 rank          a
                                                                                         0.00   0.00          1       0
                                                                                         0.13   0.13          2       1
                                                                                         0.25   0.25          3       2
                                                                                         0.50   0.50          4       4
                                                                                         0.13   0.13          5       1
                                                                                         0.00   0.00 na               0
                                                              Mature projects with new
                                                              functionality                            rank       b
                                                                                         0.00   0.00          1       0
                                                                                         0.38   0.38          2       3
                                                                                         0.25   0.25          3       2
                                                                                         0.13   0.13          4       1
                                                                                         0.25   0.25          5       2
                                                                                         0.00   0.00 na               0

                                                              Maintenance projects (where
                                                              the software is being
                                                              supported but relatively few
                                                              new features are added)                  rank       c
                                                                                         0.13   0.13          1       1
                                                                                         0.38   0.38          2       3
                                                                                         0.25   0.25          3       2
                                                                                         0.00   0.00          4       0
                                                                                         0.25   0.25          5       2
                                                                                         0.00   0.00 na               0

                                                              Agile or lightweight projects
                                                              (for example eXtreme projects,
                                                              extremeprogramming.org)                  rank       d
                                                                                         0.25   0.17          1       1
                                                                                         0.25   0.17          2       1
                                                                                         0.25   0.17          3       1
                                                                                         0.00   0.00          4       0
                                                                                         0.25   0.17          5       1
                                                                                    0.50        0.33 na               2
                                                           Open source, public domain
                                                           projects                                    rank       e
                                                                                         0.00   0.00          1       0
                                                                                         0.33   0.29          2       2
                                                                                         0.00   0.00          3       0
                                                                                         0.50   0.43          4       3
                                                                                         0.17   0.14          5       1
                                                                                         0.17   0.14 na               1
In your experience, how important is each of the
following items in helping to create effective software
documentation (requirements, design, architecture, …)
to its audience. Rate the LEAST important item as one
(1) and MOST important item as five (5). All other items
are somewhere in between.                                  Length (not too short, not too
                                                           long)                                  9 rank          a
                                                                                         0.00   0.00          1       0
                                                                                         0.13   0.13          2       1
                                                                                         0.50   0.50          3       4
                                                                                         0.25   0.25          4       2
                                                                                         0.13   0.13          5       1
                                                                                         0.00   0.00 na               0

                                                           Availability (ability to retrieve
                                                           the most current version)                   rank       b
                                                                                         0.00   0.00          1       0
                                                                                         0.00   0.00          2       0
                                                                                         0.25   0.25          3       2
                                                                                         0.38   0.38          4       3
                                                                                         0.38   0.38          5       3
                                                                                         0.00   0.00 na               0
                                                           Organization (table of
                                                           contents, categorized, sub-
                                                           categorized, etc)                           rank       c
                                                                                         0.00   0.00          1       0
                                                                                         0.00   0.00          2       0
                                                                                         0.25   0.25          3       2
                                                                                         0.50   0.50          4       4
                                                                                         0.25   0.25          5       2
                                                                                         0.00   0.00 na               0
                                                           Navigation (internal / external
                                                           links, actual links or just
                                                           references)                                 rank       d
                                                                                         0.00   0.00          1       0
                                                                                         0.25   0.25          2       2
                                                                                         0.25   0.25          3       2
                                                                                         0.38   0.38          4       3
                                                                                         0.13   0.13          5       1
                                                                                         0.00   0.00 na               0

                                                           Document structure
                                                           (arrangement of text, tables,
                                                           figures and diagrams)                       rank       e
                                                                                         0.00   0.00          1       0
                            0.13   0.13          2       1
                            0.38   0.38          3       3
                            0.38   0.38          4       3
                            0.13   0.13          5       1
                            0.00   0.00 na               0
Document's format (i.e.
Microsoft Word, Note Pad,
Visio, Html, Pdf)                         rank       f
                            0.14   0.14          1       1
                            0.43   0.43          2       3
                            0.29   0.29          3       2
                            0.14   0.14          4       1
                            0.00   0.00          5       0
                            0.00   0.00 na               0
Author                                    rank       g
                            0.38   0.38          1       3
                            0.25   0.25          2       2
                            0.13   0.13          3       1
                            0.13   0.13          4       1
                            0.13   0.13          5       1
                           0.00    0.00 na               0
Content (the information that a
document contains)                        rank       i
                            0.00   0.00          1       0
                            0.00   0.00          2       0
                            0.00   0.00          3       0
                            0.25   0.25          4       2
                            0.75   0.75          5       6
                            0.00   0.00 na               0

Type (requirements,
specification, detailed design,
architectural document)                   rank       j
                            0.00   0.00          1       0
                            0.13   0.13          2       1
                            0.25   0.25          3       2
                            0.38   0.38          4       3
                            0.25   0.25          5       2
                            0.00   0.00 na               0
Influence from management /
project leaders / other
developers to use it                      rank       k
                            0.14   0.13          1       1
                            0.43   0.38          2       3
                            0.43   0.38          3       3
                            0.00   0.00          4       0
                            0.00   0.00          5       0
                            0.14   0.13 na               1
Spelling and grammar                      rank       l
                            0.00   0.00          1       0
                            0.13   0.13          2       1
                            0.63   0.63          3       5
                            0.25   0.25          4       2
                                                                                0.00   0.00          5       0
                                                                                0.00   0.00 na               0
                                                    Writing Style (choice of words,
                                                    sentence and paragraph
                                                    structure)                                rank       m
                                                                                0.00   0.00          1       0
                                                                                0.13   0.13          2       1
                                                                                0.38   0.38          3       3
                                                                                0.38   0.38          4       3
                                                                                0.13   0.13          5       1
                                                                                0.00   0.00 na               0

                                                    Extent to which it is up-to-date          rank       n
                                                                                0.00   0.00          1       0
                                                                                0.00   0.00          2       0
                                                                                0.14   0.14          3       1
                                                                                0.43   0.43          4       3
                                                                                0.43   0.43          5       3
                                                                             0.00      0.00 na               0
                                                    Use of modelling diagrams
                                                    (UML, SDL, etc)                           rank       o
                                                                                0.00   0.00          1       0
                                                                                0.25   0.25          2       2
                                                                                0.38   0.38          3       3
                                                                                0.25   0.25          4       2
                                                                                0.13   0.13          5       1
                                                                                0.00   0.00 na               0
                                                    Use of examples (how to
                                                    extend or customize a
                                                    feature).                                 rank       p
                                                                                0.00   0.00          1       0
                                                                                0.00   0.00          2       0
                                                                                0.13   0.13          3       1
                                                                                0.63   0.63          4       5
                                                                                0.25   0.25          5       2
                                                                                0.00   0.00 na               0
How relevant are the following factors in causing
software documentation to be out of sync with the
system it describes. Rate between one (1) as a
completely IRRELEVANT factor and five (5) as an     Time constraints on
extremely RELEVANT factor                           developers                          12 rank          a
                                                                                0.00   0.00          1       0
                                                                                0.13   0.13          2       1
                                                                                0.13   0.13          3       1
                                                                                0.38   0.38          4       3
                                                                                0.38   0.38          5       3
                                                                                0.00   0.00 na               0
                                                    Budget constraints on the
                                                    project                                   rank       b
                                                                                0.00   0.00          1       0
                                                                                0.25   0.25          2       2
                                                                                0.38   0.38          3       3
                                                                                0.25   0.25          4       2
                                                                                0.13   0.13          5       1
                          0.00   0.00 na               0
High costs of maintaining
documentation is not worth the
effort                                  rank       c
                          0.00   0.00          1       0
                          0.25   0.25          2       2
                          0.38   0.38          3       3
                          0.25   0.25          4       2
                          0.13   0.13          5       1
                          0.00   0.00 na               0
Rapid changes in
requirements                            rank       d
                          0.13   0.13          1       1
                          0.00   0.00          2       0
                          0.13   0.13          3       1
                          0.50   0.50          4       4
                          0.25   0.25          5       2
                          0.00   0.00 na               0
Rapid staff turnover                    rank       e
                          0.00   0.00          1       0
                          0.71   0.63          2       5
                          0.00   0.00          3       0
                          0.00   0.00          4       0
                          0.29   0.25          5       2
                          0.14   0.13 na               1

Team members do not believe
in documenting their code               rank       f
                          0.00   0.00          1       0
                          0.13   0.13          2       1
                          0.13   0.13          3       1
                          0.13   0.13          4       1
                          0.63   0.63          5       5
                          0.00   0.00 na               0
Team members are
unmotivated to document their
code                                    rank       g
                          0.13   0.13          1       1
                          0.00   0.00          2       0
                          0.13   0.13          3       1
                          0.00   0.00          4       0
                          0.75   0.75          5       6
                          0.00   0.00 na               0
Team members see little
benefit in always maintaining
supporting documents                    rank       h



                          0.13   0.13          1       1



                          0.13   0.13          2       1
                                                                               0.13   0.13          3       1



                                                                               0.13   0.13          4       1



                                                                               0.50   0.50          5       4



                                                                               0.00   0.00 na               0
Relative to past projects, please compare the amount of
documentation being produced in your current project
compared to the amount of software delivered (i.e.. lines
of code, features developed, etc). Rate between one (1)
as extremely LESS documentation and five (5) as
extremely MORE documentation.
                                                            Requirements               38 rank          a
                                                                               0.29   0.29          1       2
                                                                               0.29   0.29          2       2
                                                                               0.00   0.00          3       0
                                                                               0.14   0.14          4       1
                                                                               0.29   0.29          5       2
                                                                               0.00   0.00 na               0
                                                            Specifications                   rank       b
                                                                               0.29   0.29          1       2
                                                                               0.14   0.14          2       1
                                                                               0.14   0.14          3       1
                                                                               0.29   0.29          4       2
                                                                               0.14   0.14          5       1
                                                                               0.00   0.00 na               0
                                                            Detailed Design                  rank       c
                                                                               0.29   0.29          1       2
                                                                               0.14   0.14          2       1
                                                                               0.14   0.14          3       1
                                                                               0.29   0.29          4       2
                                                                               0.14   0.14          5       1
                                                                               0.00   0.00 na               0
                                                            Low Level Design                 rank       d
                                                                               0.33   0.33          1       2
                                                                               0.17   0.17          2       1
                                                                               0.17   0.17          3       1
                                                                               0.17   0.17          4       1
                                                                               0.17   0.17          5       1
                                                                               0.00   0.00 na               0
                                                            Architectural                    rank       e
                                                                               0.14   0.14          1       1
                                                                               0.00   0.00          2       0
                                                                               0.43   0.43          3       3
                                                                               0.29   0.29          4       2
                                                                               0.14   0.14          5       1
                                                                               0.00   0.00 na               0
                                                         Testing / Quality Documents                 rank       f
                                                                                       0.14   0.14          1       1
                                                                                       0.14   0.14          2       1
                                                                                       0.29   0.29          3       2
                                                                                       0.14   0.14          4       1
                                                                                       0.29   0.29          5       2
                                                                                       0.00   0.00 na               0
Relative to past projects, please compare the quality of
the software of your current project. Rate between one
(1) for much LOWER quality and five (5) much HIGHER
quality.                                                 # Defects per line of code.           39 rank          a
                                                                                       0.00   0.00          1       0
                                                                                       0.17   0.14          2       1
                                                                                       0.50   0.43          3       3
                                                                                       0.33   0.29          4       2
                                                                                       0.00   0.00          5       0
                                                                                       0.17   0.14 na               1
                                                         Team members' pride in
                                                         project                                     rank       b
                                                                                       0.00   0.00          1       0
                                                                                       0.14   0.14          2       1
                                                                                       0.57   0.57          3       4
                                                                                       0.14   0.14          4       1
                                                                                       0.14   0.14          5       1
                                                                                    0.00      0.00 na               0
                                                         Manager's satisfaction with the
                                                         projects progress                           rank       c
                                                                                       0.00   0.00          1       0
                                                                                       0.00   0.00          2       0
                                                                                       0.71   0.71          3       5
                                                                                       0.29   0.29          4       2
                                                                                       0.00   0.00          5       0
                                                                                       0.00   0.00 na               0
                                                         Customer Satisfaction                       rank       d
                                                                                       0.00   0.00          1       0
                                                                                       0.00   0.00          2       0
                                                                                       0.33   0.29          3       2
                                                                                       0.50   0.43          4       3
                                                                                       0.17   0.14          5       1
                                                                                       0.17   0.14 na               1
                                                         Project delivery on time                    rank       e
                                                                                       0.00   0.00          1       0
                                                                                       0.29   0.29          2       2
                                                                                       0.29   0.29          3       2
                                                                                       0.14   0.14          4       1
                                                                                       0.29   0.29          5       2
                                                                                       0.00   0.00 na               0
                                                         Project delivery on budget                  rank       f
                                                                                       0.00   0.00          1       0
                                                                                       0.14   0.14          2       1
                                                                                       0.57   0.57          3       4
                                                                                       0.14   0.14          4       1
                                                                                       0.14   0.14          5       1
                                                                                   0.00      0.00 na               0
Relative to past projects, please compare the quality of
the documentation of your current project. Rate between Maintenance (Is is easier to
one (1) for much LOWER quality and five (5) much         keep the documents up to
HIGHER quality.                                          date?)                               40 rank          a
                                                                                     0.00    0.00          1       0
                                                                                     0.50    0.43          2       3
                                                                                     0.00    0.00          3       0
                                                                                     0.33    0.29          4       2
                                                                                     0.17    0.14          5       1
                                                                                      0.17   0.14 na               1
                                                        Writing style (Is it easier to
                                                        read and understand?)                       rank       b
                                                                                     0.17    0.14          1       1
                                                                                     0.00    0.00          2       0
                                                                                     0.17    0.14          3       1
                                                                                     0.50    0.43          4       3
                                                                                     0.17    0.14          5       1
                                                                                     0.17    0.14 na               1

                                                        Navigation (Is it easier to
                                                        move between documents?)                    rank       c
                                                                                     0.00    0.00          1       0
                                                                                     0.00    0.00          2       0
                                                                                     0.33    0.29          3       2
                                                                                     0.50    0.43          4       3
                                                                                     0.17    0.14          5       1
                                                                                     0.17    0.14 na               1

                                                        Searching (Is it easier to find
                                                        the information you need?)                  rank       d


                                                                                     0.00    0.00          1       0


                                                                                     0.17    0.14          2       1


                                                                                     0.33    0.29          3       2


                                                                                     0.33    0.29          4       2


                                                                                     0.17    0.14          5       1


                                                                                     0.17    0.14 na               1
                                                        Updated (Are the documents
                                                        more up to date?)                           rank       e

                                                                                     0.17    0.14          1       1

                                                                                     0.00    0.00          2       0
                                                                                     0.17   0.14          3       1

                                                                                     0.50   0.43          4       3

                                                                                     0.17   0.14          5       1

                                                                                    0.17    0.14 na               1
To what extent does your software team do the following
activities. This list is described by Joel Spolsky as The
Joel Test. More information is available online at
joelonsoftware.com. Rate between one (1) for NEVER
and five (5) for ALWAYS.                                  Use source control (ie. CVS
                                                          system)                            48 rank          a
                                                                                     0.00   0.00          1       0
                                                                                     0.13   0.13          2       1
                                                                                     0.00   0.00          3       0
                                                                                     0.13   0.13          4       1
                                                                                     0.75   0.75          5       6
                                                                                     0.00   0.00 na               0
                                                         Have daily builds                         rank       b
                                                                                     0.00   0.00          1       0
                                                                                     0.29   0.25          2       2
                                                                                     0.43   0.38          3       3
                                                                                     0.00   0.00          4       0
                                                                                     0.29   0.25          5       2
                                                                                     0.14   0.13 na               1
                                                         Maintain a bug database                   rank       c
                                                                                     0.00   0.00          1       0
                                                                                     0.00   0.00          2       0
                                                                                     0.00   0.00          3       0
                                                                                     0.50   0.50          4       4
                                                                                     0.50   0.50          5       4
                                                                                    0.00    0.00 na               0
                                                         Fix bugs before writing new
                                                         code                                      rank       d
                                                                                     0.00   0.00          1       0
                                                                                     0.13   0.13          2       1
                                                                                     0.63   0.63          3       5
                                                                                     0.13   0.13          4       1
                                                                                     0.13   0.13          5       1
                                                                                     0.00   0.00 na               0

                                                         Keep an up-to-date schedule               rank       e
                                                                                     0.14   0.14          1       1
                                                                                     0.14   0.14          2       1
                                                                                     0.00   0.00          3       0
                                                                                     0.57   0.57          4       4
                                                                                     0.14   0.14          5       1
                                                                                     0.00   0.00 na               0
                                                         Have a specifications
                                                         document for your project                 rank       f
                                                                                     0.13   0.13          1       1
                                                                                     0.38   0.38          2       3
                          0.00    0.00          3       0
                          0.25    0.25          4       2
                          0.25    0.25          5       2
                          0.00    0.00 na               0
Have new candidates for the
development team write code
during the interview                     rank       h
                          0.43    0.38          1       3
                          0.57    0.50          2       4
                          0.00    0.00          3       0
                          0.00    0.00          4       0
                          0.00    0.00          5       0
                          0.14    0.13 na               1
Have testers                             rank       j
                          0.13    0.13          1       1
                          0.13    0.13          2       1
                          0.13    0.13          3       1
                          0.13    0.13          4       1
                          0.50    0.50          5       4
                          0.00    0.00 na               0
Conduct hallway usability tests
(ie. Grab someone from the
hallway to try the newly added
feature)                               rank         k
                           0.38   0.38          1       3
                           0.38   0.38          2       3
                           0.25   0.25          3       2
                           0.00   0.00          4       0
                           0.00   0.00          5       0
                           0.00   0.00 na               0
162   178   181   182        183        187   201     205   212




 1            1               1          2     2       4




 3            5               2          2     3       3




 3            3               3          3     3       3




 4            5               3          3     4 na




 3            4               3          3     3       2




 2            4         na         na          4       4
1   5        2        1   2   1




1   2        3        1   2   3




4   3        4        2   3   3




4   3        4        2   2   1




3   3        4        2   3   1




1   5   na       na       2   3
2   2   3   2   2   4




4   2   4   2   3   4




2   4   5   2   5   4




2   4   5   2   4   4




5   3   5   2   3   4




5   5   5   4   3   4
2   5   1   1   4   4




4   5   3   2   5   3




3   5   4   1   3   3




3   5   3   2   3   4




4   5   2   3   4   4




4   5   4   4   4   5




4   4   2   1   4   2
5   5   3      2   5   5




3   5   2      2   5   5




2   4   2      2   3   4




4   4   3      3   4   4




4   4   5      4   4   1




2   5   4      2   5   4




2   2   3 na       4   3
2   2   5   2   4      5




2   3   4   1   4      4




2   3   5   1   3 na




4   5   3   2   3      3




2   3   5   2   5      5




3   4   5   2   5      5
3        4   2   1   4   3




3        4   4   3   4   4




2        2   4   2   3   5




2        2   2   1   3   5




1   na       3           2
5   4   2       4   2




3   3   4   4   2   3




3   4   4   5   5   4




3   4   3   4   5   4




3   4   4   4   5   2




3   4   3   4   5   4
2   3   1   2   4   3




2   2   1   4   3   1




5   5   5   5   5   4




5   4   4   2   3   4




2   3   1   2   3   2




2   4   3   3   3   3
3   4   3   3   4   2




4       4   5   5   5




4   3   2   3   5   3




4   4   4   4   5   3




4   2   5   3   5   5




4   2   2   3   5   3
3   2   3   5   4   4




4   5   4   4   3   5




2   5   2   2   5   2




5   5   5   5   4   5




5   5   5   5   5   5




5   5   5   5   4   3
1   5   2   1   5




1   5   3   1   4




2   5   4   1   3




1   5   4   1   3




3   5   3   1   4
3   5   3   1      5




2   4   4   3 na




3   5   3   3      4




3   4   3   3      4




4   5   4   3 na




2   5   2   3      4




3   5   2   3      4
2   5   4 na   2




1   5   4 na   4




3   5   4 na   4




2   5   4 na   3




1   5   4 na   3
5   5   5   5   5   5




2   5   3   2   3   3




5   5   5   4   5   4




3   3   4   3   5   2




1       4   2   5   4




2   5   2   1   5   4
1   2   2   2   2 na




5   2   5   3   4      5




3   2   2   3   1      2
217   232   248   251   10   16   20




       3                     2




       3                     3




       3                     3




                             3




       3                     3




       3                     4
3   3




3   4




3   4




    4




3   4




3   4
5   2




5   2




5   4




    4




5   3




5   3
4   3




2   3




4   4




    4




5   4




5   5




5   4
5   5




5   5




    4




5   5




5   5




4   3




4   4
     3   4




na       5




     5   3




     5   2




     4   4




     4   4
5        5




5        2




5        3




5        3




5   na
na       4




     5   3




     5   3




     4   5




     3   2




     3   2
         2




     5   1




     5   4




     5   3




na       3




     4   3
5   4




4   3




4   2




5   4




4   4




4   3
     3   2




     1   4




na       2




     3   2




     3   1




     2   1
4   2




4   2




4   1




    2




4   3
4   2




3   3




3   2




3   3




3   4




3   5




3   3
4   2




3   4




3   4




4   3




4   4
     4   2




na       5




     4   4




     3   3




     4   4




     4   2
1   1




1   5




1   1
Question                                                      Options   QID   Type         Letter       128
If software documentation could be graded (based on
several factors such as appropriate length, readability,
accuracy, ease of use, and the extent to which it is up to
date) then it might be more useful to me.
                                                                          13 opinion                     3
                                                                                       1            2
                                                                                       2            3
                                                                                       3            3
                                                                                       4            4
                                                                                       5            4
                                                                              na                    0
Software documentation is important, but in my
organization it is unfortunately not that useful.                         14 opinion                     4
                                                                                       1            7
                                                                                       2            4
                                                                                       3            0
                                                                                       4            4
                                                                                       5            2
                                                                              na                    0
Software documentation that I reference is easy to
understand, navigate and cross reference.                                 15 opinion                     4
                                                                                       1            3
                                                                                       2            4
                                                                                       3            1
                                                                                       4            7
                                                                                       5            2
                                                                              na                    0
The language / style of writing in software documentation
I reference is brief and to the point.                                    16 opinion                     4
                                                                                       1            0
                                                                                       2            9
                                                                                       3            0
                                                                                       4            8
                                                                                       5            0
                                                                              na                    0
When I am working on a software system and require
assistance, it is easy to locate the appropriate supporting
documentation.                                                            17 opinion                     3
                                                                                       1            1
                                                                                       2            8
                                                                                       3            2
                                                                                       4            5
                                                                                       5            1
                                                                              na                    0
Tools to view and browse software documents are bulky
and inefficient.                                                          18 opinion                     5
                                                                                       1            1
                                                                                       2            5
                                                                                       3            6
                                                                                       4            3
                                                                                       5            1
                                                                              na                    1
Tools to view and browse software documents facilitate
my work.                                                    19 opinion                    4
                                                                         1   0
                                                                         2   1
                                                                         3   5
                                                                         4   8
                                                                         5   2
                                                               na            1
Documentation is always outdated relative to the current
state of a software system.                                 20 opinion                    4
                                                                         1   2
                                                                         2   5
                                                                         3   0
                                                                         4   8
                                                                         5   1
                                                               na            0
Software documentation can be useful even through it
might not always be the most up to date (relative the
system it documents).                                       21 opinion                    4
                                                                         1   0
                                                                         2   2
                                                                         3   0
                                                                         4   10
                                                                         5   5
                                                               na            0
Most software documents have a finite useful lifetime
and should be subsequently discarded (or removed from
the primary document repository).                           22 opinion                    5
                                                                         1   2
                                                                         2   8    58.8235294
                                                                         3   0           17
                                                                         4   5    41.1764706
                                                                         5   2
                                                               na            0
The cost of maintaining most software documents
greatly outweighs the benefits of having such documents
up to date.                                                 23 opinion                    2
                                                                         1   7
                                                                         2   6
                                                                         3   1
                                                                         4   1
                                                                         5   2
                                                               na            0
Software documentation contains a lot of information that
can be extracted directly from the system’s source code
itself.                                                     24 opinion                    4
                                                                         1   3
                                                                         2   6
                                                                         3   1
                                                                         4   3
                                                                         5   4
                                                               na            0
Tools that help extract information from source code (for
example JavaDoc) are extremely powerful for creating
supporting documentation.                                    25 opinion                    5
                                                                          1   1
                                                                          2   4
                                                                          3   4
                                                                          4   5
                                                                          5   2
                                                                na            1
Software documentation concentrates too heavily on
high level issues rather than the important
implementation details.                                      26 opinion                    2
                                                                          1   1
                                                                          2   8
                                                                          3   3
                                                                          4   4
                                                                          5   0
                                                                na            1
Software documentation that I have found useful during
inception / construction of a system differs from that
which I find useful during maintenance and testing of that
system.                                                      27 opinion                    5
                                                                          1   2
                                                                          2   3    29.4117647
                                                                          3   0           17
                                                                          4   6    70.5882353
                                                                          5   6
                                                                na            0
Much more effort is required to format / prepare software
documentation than the effort of providing the actual
content for the documents.                                   28 opinion                    4
                                                                          1   6
                                                                          2   4
                                                                          3   0
                                                                          4   6
                                                                          5   1
                                                                na            0
I practice (or am trying to practice) agile software
(agilemanifesto.org) techniques (i.e. eXtreme
Programming (extremeprogramming.org) and Test First
programming) and believe in the effectiveness of unit
testing.                                                     29 opinion           na
                                                                          1   3
                                                                          2   5
                                                                          3   0
                                                                          4   0
                                                                          5   0
                                                                na            9
Automated testing (such as J-Unit) helps exhibit the true
state of a system and is a useful tool for software
documentation.                                               30 opinion                    3
                                                                          1   1
                                                                          2   3
                                                                          3   3
                                                                          4   4
                                                                          5   0
                                                                na            6
It would be useful to have tools to track changes in a
software system for the purpose of updating and
maintaining its supporting documentation.                    31 opinion            5
                                                                          1   1
                                                                          2   0
                                                                          3   0
                                                                          4   6
                                                                          5   9
                                                                na            0
I would rather refactor / update / debug / test a system
then document it in its present (and flawed) state.
                                                             32 opinion            4
                                                                          1   1
                                                                          2   4
                                                                          3   2
                                                                          4   6
                                                                          5   1
                                                                na            3
We use a useful configuration management system to
maintain our software documentation.                         33 opinion            5
                                                                          1   4
                                                                          2   3
                                                                          3   0
                                                                          4   8
                                                                          5   1
                                                                na            1
Software documentation (i.e. the collection of documents
describing a particular system) that I reference is poorly
organized and difficult to navigate primarily due to the
size and number of the documents available.
                                                             34 opinion            4
                                                                          1   3
                                                                          2   1
                                                                          3   1
                                                                          4   10
                                                                          5   2
                                                                na            0
Only a few software documents are personally useful to
me.                                                          35 opinion            4
                                                                          1   1
                                                                          2   4
                                                                          3   1
                                                                          4   8
                                                                          5   2
                                                                na            1

                                                                              0
                                                                              0
                                                                              0
                                                                              0
                                                                              0
0

0
0
0
0
0
0

0
0
0
0
0
0

0
0
0
0
0
0
162     178   181   182   183   187   201   205   212




 3       2      5    2     1     5     4     3     4




 5       1      4    4     1     5     2     1     4




 1       5      4    2     3     1     4     2     4




 2       4      2    4     4     2     2     2     2




 2       2      2    1     4     2     2     4     2




 3 na           3    3     2     3     3     4     2
2 na       4   4   3   3   4   3   4




2          4   4   2   5   4   4   4




4      5   4   4   4   4   5   5   4




4      2   2   2   2   2   4   2   2




1      1   2   1   2   1   5   1   2




1      5   1   2   2   2   5   4   2
2   4      2   2   3      2        3      4   4




2   2      4   2   3      2        4      2   2




2   5      5   4   4      4        5      2   4




2   1      5   1   4      2        4      1   1




1   1 na       2   2 na       na          2   2




2   1 na       3   2 na            4 na       4
4   4   5   4   4      5        5   5   4




4   4   4   3   2 na       na       2   2




4   1   1   1   4      2        4   1   4




4   1   5   4   3      4        4   5   4




4   4   2   4   3      4 na         5   4
217   232   248   251   10   16   20




 1     5      4    5         2    4




 2     1      1    2    2    1    1




 1     2      5    2    4    4    4




 2     4      4    2    2    4    4




 3     4      5    2    4    2    4




 1     4      2    3    2    2    4
5   5   4   3   4   3   4




1   1   2   2   4   2   4




4   5   4   2   2   5   4




5   1   2   4   1   4   4




5   1   1   2   3   2   4




5   5   2   3   2   1   4
     5 na            4        3        3        1   4




     4        1 na            3        3        2   4




     5        1      1        2        4        5   4




     1        4      1        2        2        4   4




na            1 na       na       na       na       2




na       na          4        2   na            4   3
1   5   4            5   5   5




4   5   2   4   na       1   3




2   2   4   4   na       4   4




1   4   2   4        4   1   4




2   2   2   4        4   1   5
                   Clients       Manager                  Jr.
                                               Sr. Developer Developer
Requirements                 3             3            1         1
Specifications               0             2            5         0
Detailed Design              0             0            8         0
Low Level Design             0             0            3         2
Architectural                0             1            6         1
Testing / QA                 0             1            1         4




                   Clients       Manager                  Jr.
                                               Sr. Developer Developer
Requirements                 3             2            2         0
Specifications               2             2            3         1
Detailed Design              0             1            4         3
Low Level Design             1             2            1         3
Architectural                1             1            4         2
Testing / QA                 1             1            2         1




T-Test Data
Req
Spec
DD
LLD
Arch
QA

Req
Spec
DD
LLD
Arch
QA
           N/A
Technical Writer                       Clients                       Jr.
                                                  Manager Sr. Developer Developer
        0          0       Requirements        38       38       13         13
        1          0       Specifications       0       25       63          0
        0          0       Detailed Design      0        0      100          0
        1          1       Low Level Design 0            0       43         29
        0          0       Architectural        0       13       75         13
        0          2       Testing / QA         0       13       13         50




           N/A
Technical Writer                       Clients                           Jr.
                                                      Manager Sr. Developer Developer
        1          0       Requirements          38         25       25          0
        0          0       Specifications        25         25       38         13
        0          0       Detailed Design        0         13       50         38
        0          0       Low Level Design      14         29       14         43
        0          0       Architectural         13         13       50         25
        1          2       Testing / QA          13         13       25         13




                   1   1                          1           2        2         4
                   3   5                          2           2        3         3
                   3   3                          3           3        3         3
                   4   5                          3           3        4 na
                   3   4                          3           3        3         2
                   2   4              na              na               4         4


                   1   5                          2           1        2         1
                   1   2                          3           1        2         3
                   4   3                          4           2        3         3
                   4   3                          4           2        2         1
                   3   3                          4           2        3         1
                   1   5              na              na               2         3
           N/A
Technical Writer
        0           0
       13           0
        0           0
       14          14
        0           0
        0          25




           N/A
Technical Writer
       13           0
        0           0
        0           0
        0           0
        0           0
       13          25




                        3   2
                        3   3
                        3   3
                            3
                        3   3
                        3   4

                        3   3
                        3   4
                        3   4
                            4
                        3   4
                        3   4
Question                                                   Options                       QID    Type        Letter        128
Which types of software documentation do you write /
edit / verify? Check all that apply. For this survey
references to the term 'software documentation' imply
documents geared for software developers that support
a given system and NOT for end users.
                                                           Requirements                        1 checkbox   a              1
                                                           Specifications                       checkbox    b              1
                                                           Detailed Design                      checkbox    c              1
                                                           Low Level Design                     checkbox    d              1
                                                           Architectural                        checkbox    e              1
                                                           Testing / Quality Documents          checkbox    f
                                                                                                                     10
                                                                                                                     13
                                                                                                                     10
                                                                                                                     8
                                                                                                                     9
                                                                                                                     9
What is the size of your current (or recently completed)   < 1 KLOC (KLOC = 1000 lines
project in KLOCS.                                          of code)                        41 radio         a
                                                           between 1 and 5 KLOCS                radio       b
                                                           between 5 – 20 KLOCS                 radio       c
                                                           between 20 – 50 KLOCS                radio       d
                                                           between 50 – 100 KLOCS               radio       e              1
                                                           over 100 KLOCS                       radio       f
                                                           N/A                                  radio       na
                                                                                                                     0
                                                                                                                     0
                                                                                                                     4
                                                                                                                     3    16
                                                                                                                     2
                                                                                                                     1
                                                                                                                     6
How long have you been working in the software field?
                                                           < 1 year                        42 radio         a
                                                           1 - 4 years                          radio       b
                                                           5-10 years                           radio       c
                                                           > 10 years                           radio       d              1
                                                                                                                     0
                                                                                                                     3
                                                                                                                     7
                                                                                                                     7
What is / are your current job function(s)?                Manager                         44 checkbox      a              1
                                                           Project Leader                       checkbox    b
                                                           Software Architects.                 checkbox    c              1
                                                           Sr. Software Developer               checkbox    d
                                                           Jr. Software Developers              checkbox    e
                                                           Technical Writers                    checkbox    f
                                                           Software Support                     checkbox    g
                                                           Quality Assurance                    checkbox    h
                                                           Student                              checkbox    i
                                                           Other                                checkbox    j
                                                           None of the above                    checkbox    k
                                                                                                4
                                                                                                3
                                                                                                4
                                                                                                3
                                                                                                0
                                                                                                8
                                                                                                1
                                                                                                3
                                                                                                0
                                                                                                1
                                                                                                2
What are some past job functions you have held?   Manager                     45 checkbox   a
                                                  Project Leader                checkbox    b       1
                                                  Software Architects.          checkbox    c
                                                  Sr. Software Developer        checkbox    d       1
                                                  Jr. Software Developers       checkbox    e       1
                                                  Technical Writers             checkbox    f
                                                  Software Support              checkbox    g
                                                  Quality Assurance             checkbox    h
                                                  None of the above             checkbox    k
                                                                                                4
                                                                                                7
                                                                                                0
                                                                                                8
                                                                                                8
                                                                                                7
                                                                                                5
                                                                                                6
                                                                                                1
What type of development process(es) does your
company / manager recommend?                      No defined process          46 checkbox   a
                                                  Waterfall model               checkbox    b       1
                                                  Incremental model             checkbox    c
                                                  Iterative model               checkbox    d
                                                  Agile process                 checkbox    e
                                                  Test first strategies         checkbox    f
                                                  Rational unified process      checkbox    g
                                                  Personal software process     checkbox    h
                                                  Clean Room Approach           checkbox    i
                                                  Code and Debug                checkbox    j
                                                  Internal Process              checkbox    k       1
                                                  Other                         checkbox    l       1
                                                  N/A                           checkbox    m
                                                                                                1
                                                                                                4
                                                                                                4
                                                                                                4
                                                                                                1
                                                                                                2
                                                                                                1
                                                                                                0
                                                                                                0
                                                                                                3
7
2
1
162   178   181   182   183   187   201   205   212




 1     1      1    1           1
 1     1      1    1     1     1     1     1
       1      1    1           1     1
       1      1          1     1           1
       1      1    1     1     1
 1            1                1     1




                   1     1
              1                      1
 1
                                                 1
       1                                   1




              1
 1     1                 1     1     1     1
                   1                             1




                                                 1
       1           1
       1           1
       1           1


       1      1    1     1     1     1     1
              1
 1            1


                   1
1           1
1           1                   1


1   1       1                   1
            1   1               1
        1   1   1       1   1
        1           1       1
1       1       1           1




1
            1                   1
1   1
            1


                        1
            1



1                   1       1
            1   1           1
217   232   248   251   10   16   20




       1      1    1         1
       1      1    1         1
       1      1    1         1
                   1         1
       1           1         1
       1      1    1         1    1




 1                 1
       1



              1         1    1    1




              1                   1
                             1
 1     1           1    1




                   1    1
 1
       1
              1


                             1

                                  1


              1         1
            1   1
1           1       1

1   1       1
1       1   1       1
                1   1
        1           1
1                   1
                        1




    1
    1   1
    1   1           1
    1
                        1




1           1   1
                        1
        1
Question                                                     Options   QID   Type      Letter            128
What types of software artefacts (ie. use case maps,
sequence diagrams, CRC cards, finite state machines)
do you find MOST effective for software documentation?
Briefly justify how these artefacts are effective and                    10 textarea            Reengineering code into XMI to
What types of software artefacts do you find LEAST
effective for software documentation? Briefly justify your
answer.
                                                                         11 textarea            Requirements - the bullet list h
Which software tools do you find MOST helpful to create
/ edit / browse / generate software documentation? (For
example, text editors, word processors, spreadsheets,
JavaDoc).                                                                36 textarea            JavaDoc Rational Rose
Which software tools do you find LEAST helpful to create
/ edit / browse / generate software documentation?

                                                                         37 textarea            Word Acrobat
What type of products / services does your company
offer?

                                                                         43 textarea            A unique software integration to
Describe to what extent you are successful at following
the recommended development process(es).


                                                                         47 textarea            Don't even want to - our team i
Do you use tools to automatically document your
system? If so, which tools and to what extent.


                                                                         49 textarea            JavaDoc for Java code docume
Briefly describe your companies policy for software
documentation? To what extent and how successfully is
it followed?

                                                                         50 textarea            My company doesn't have a fix
                        162           178            181           182           183            187            201           205            212



                            sequence class diagrams, example whether you future Any kind ofby fonctions with screen documentation".pseudo meandefine the for creatin
                                         When           a system, really suretablesyou meanthe in creatingtype of diagramuse to lookuse cases, etc are extensive expla
                                                                        Not like what programmers" that quickly summarize what which for
                                                                                        mapping process flow documentation oralso like which help us part of specialised
                                                                                                                     We include I cases, presented as effective client's s
              Object model, use cases,diagrams learningNot sure i/o,I "letters to mean artefacts used"effective for software shots(of artefacts Do youcode with just documentat



                               has little context diagrams with flowchart, Same problemway, that are poorly implemented materials and/or requirement specs are not them
                                              Big docs (thatEverything as a checklist to assure suppose. and unstructured pages of docs
                                                            aren't used with excellent moderation), very
                                                                           nobody some ones I that features it always need the
                                                                                           maintain In general, Marketing
Requirements - the bullet listpre/post conditionand can only be used is useful in want toas before.themlongexist in the system. presence of the author to understand very hel



                           text editor on html. framemaker, excel, visio, & publishing tools needed;to put docs,what theywe creating content with? Usually, the or just by p
                                          Word,       Word processors textpad, also a good place otherwise, Word browsers/help by some class Tools
                                                                      Obviously, homesite, robohelp             and are can beProprietary Reviewing browsers software r
              word processor, database systemclass description texts (python) areeditors are such as FrameMaker, web processorsreadviewers, Acrobat



              word processor                             Spreadsheets,Inflexible compilers
                                                                       text editors                          Spreadsheets
                                            javadoc nobody seems to know how to use it !!! (such as MS HTML Workshop) are my bane. Tools that are non-cross-platform a



                            OSS automation Java but system transactionnal websites, hardwaredatabase management, care and billing mainframe services plus
                                          Everything      mostly     Graphics, document editing, NPU, lookup Customer office engines
                                                                                                                              C/C++ software, & Class Libraries
              Point-of-Sale systems written inand controlTelecommunication software andfinancial/banking apps and classification suiteCompilers desktop publishing. ancilli




                                          My company works onprocessesas we followthe aren't anyas a as possiblebut with very little establish the approach we feel is a
                                                       Several smallGet areteams,in closest toas so that's pretty easy the new product/features/components. on mee
                                                                        project used as possible incremental model succesful free to documentation.
                                                                                        development process are we're relatively
                                                                                                                 Very team follow.
              successful, there is no documented process to follow. Informally familiarThere company soon whole;mainlywith to choice. The application we're workingAnd follo




                           used javadoc noJavaDoc comments, on a project once in conjunction with some plain documentation.
                                                       None          No, these tools seldom provide intelligent html
              Some of the code has basic (or something similar)but most doesn't have sufficient JavaDoc comments. docs




                                           when developersspecific overall policy;development some comments of corecode (some developers hands dirty with the and a ne
                                                        No get behind schedule isThere on cycle. Tech writers the project.documentation better than others) technolo
                                                                     Part of policy. discardedto requirements We dodevelopers/tester know what's going on stricly bu
                                                                                     I'm trying to write code. The      have
              Documentation is started butThere is no software documentationthe itdepends are the implement onein are encouraged to get theirstandards that are but anyenfo
          217           232       248            251           10           16    20
                requirements
                as written                                          Don't
UML             text         -                                      know.


none                          -                         Word        Document
                                        We have
            We only use                 standard        Visio       ation tools
            Microsoft                   templates in    Rational    (such as
            Word
JavaDoc, word processors -              various word    Rose        FrameMa
                                                                    Document
                We only use                                         ation
                Microsoft                                           extraction
                Word        -                           XML-        tools,
                                        Database
                                        and related     based
                                        applications    email plug-
            Aircraft
Development tools             -         (products,      in Email    Financial
                                                        Fairly      Reasonab
                                                        successful ly
                                                        . Doesn't successful
Not totally follow            -                         make the in



No                            -         No.                         No
                                        Functional,
                                                                    The
                                        Design, and
                                        Test specs                  informal
                                        are due for                 policy is
Usually follows               -         every feature               that user
       14                            15                                            16
count     mean      sd        count     mean      sd                        count
    17.00      2.41      1.54     17.00      3.06                      1.39     17.00

 2.411765    1.543487      1              2              5               1            17
 3.058824     1.39062      4              4              5               1            17
 2.941176    1.028992      2              2              4               2            17
 2.823529    1.131111      2              2              5               1            17
    3.0625    1.28938      4              4              5               1            16
     3.375   1.204159      4              4              5               1            16




Q4       Documentation Maintenance
Requirements                 Specs                                            DD
mean     count    sd         mean              count          sd              mean
      2.75        1.16      8           3.25           1.16               8          3.88




Q6       Who Reads What
Requirements                    Specs                                         DD
mean     count    st dev        mean           count          st dev          mean
      3.25        1.39      8           4.38           1.19               8          4.00
                                    17                                           20                                           35
mean           sd            count     mean      sd                       count     mean      sd                       count
        2.94            1.03     17.00      2.82                     1.13     16.00      3.06                     1.29     16.00




                               LL                                           Arch                                         QA
count          sd              mean          count          sd              mean          count          sd              mean
        1.25               8          3.57           1.13               7          3.75           1.16               8          4.25




                               LL                                           Arch                                         Qa
count          st dev          mean          count          st dev          mean          count          st dev          mean
        1.41               8          3.00           1.00               7          4.00           0.76               8          4.00
mean           sd
        3.38            1.20




count          sd
        0.89               8




count          st dev
        1.31               8
                      1   2   3    4   5 na
Not effective         2   3   3    4   4      0
easy to understand 7      4   0    4   2      0
brief / to point      3   4   1    7   2      0
easy to locate        0   9   0    8   0      0
tools are inefficient 1   8   2    5   1      0
                      1
tools faciliate my work   5   6    3   1      1
                      0   1   5    8   2      1
                      2   5   0    8   1      0
                      0   2   0   10   5      0
                      2   8   0    5   2      0
                      7   6   1    1   2      0
                      3   6   1    3   4      0
                      1   4   4    5   2      1
                      1   8   3    4   0      1
                      2   3   0    6   6      0
                      6   4   0    6   1      0
                      3   5   0    0   0      9
                      1   3   3    4   0      6
                      1   0   0    6   9      0
                      1   4   2    6   1      3
                      4   3   0    8   1      1
                      3   1   1   10   2      0
                      1   4   1    8   2      1
                    1   2   3   4   5 na
Length              0   1   4   2   1      0
Availability        0   0   2   3   3      0
Organization        0   0   2   4   2      0
Navigation          0   2   2   3   1      0
Structure           0   1   3   3   1      0
Format              1   3   2   1   0      0
Author              3   2   1   1   1      0
Content             0   0   0   2   6      0
Type                0   1   2   3   2      0
Influence to use it 1   3   3   0   0      1
Spelling and grammar0   1   5   2   0      0
Writing Style       0   1   3   3   1      0
Up-to-date          0   0   1   3   3      0
Use of diagrams     0   2   3   2   1      0
Use of examples     0   0   1   5   2      0

				
DOCUMENT INFO
Shared By:
Categories:
Tags:
Stats:
views:10
posted:11/10/2011
language:English
pages:113