Class Diagram for a Bank Management System - Excel by xlh79837

VIEWS: 3,655 PAGES: 113

More Info
									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.20
                                                            Specifications                        rank       b                  2.40
                                                            Detailed Design                       rank       c                  2.80
                                                            Low Level Design                      rank       d                  3.00
                                                            Architectural                         rank       e                  2.80
                                                            Testing / Quality Documents           rank       f                  2.20
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                  1.60
                                                            Specifications                        rank       b                  2.20
                                                            Detailed Design                       rank       c                  3.00
                                                            Low Level Design                      rank       d                  3.20
                                                            Architectural                         rank       e                  2.80
                                                            Testing / Quality Documents           rank       f                  2.80
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                  3.40
                                                            Specifications                        rank       b                  3.00
                                                            Detailed Design                       rank       c                  2.80
                                                            Low Level Design                      rank       d                  2.20
                                                            Architectural                         rank       e                  2.60
                                                              Testing / Quality Documents        rank   f   3.40
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.80
                                                              Specifications                     rank   b   3.60
                                                              Detailed Design                    rank   c   3.60
                                                              Low Level Design                   rank   d   2.20
                                                              Architectural                      rank   e   3.60
                                                              Testing / Quality Documents        rank   f   3.00
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.60
                                                              Specifications                     rank   b   3.20
                                                              Detailed Design                    rank   c   2.20
                                                              Low Level Design                   rank   d   1.80
                                                              Architectural                      rank   e   2.80
                                                              Testing / Quality Documents        rank   f   2.40
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.60
                                                        When MAINTAINING a
                                                        software system.                         rank   b   3.00
                                                        When TESTING a software
                                                        system.                                  rank   c   3.20
                                                              When other developers are
                                                              UNAVAILABLE to answer my
                                                              questions.                         rank   d   2.80

                                                              When explaining / answering
                                                              questions about the system to
                                                              MANAGEMENT or
                                                              CUSTOMERS.                         rank   f   2.40
                                                              When looking for BIG-
                                                              PICTURE information about
                                                              the software system                rank   g   3.00
                                                              When looking for IN-DEPTH
                                                              information about the software
                                                              system.                            rank   h   2.40
                                                              When working with a NEW
                                                              software system                    rank   i   3.20
                                                              When working with an
                                                              ESTABLISHED / MATURE
                                                              software systems                   rank   j   3.00
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   2.80
                                                              Mature projects with new
                                                              functionality                      rank   b   2.80
                                                           Maintenance projects (where
                                                           the software is being
                                                           supported but relatively few
                                                           new features are added)               rank   c   1.60

                                                           Agile or lightweight projects
                                                           (for example eXtreme projects,
                                                           extremeprogramming.org)               rank   d   2.25
                                                           Open source, public domain
                                                           projects                              rank   e   2.75
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.00

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

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

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

                                                           Extent to which it is up-to-date      rank   n   4.00
                                                           Use of modelling diagrams
                                                           (UML, SDL, etc)                       rank   o   2.40
                                                           Use of examples (how to
                                                           extend or customize a
                                                           feature).                             rank   p   3.60
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.60
                                                              Budget constraints on the
                                                              project                             rank      b   3.60
                                                              High costs of maintaining
                                                              documentation is not worth the
                                                              effort                              rank      c   3.00
                                                              Rapid changes in
                                                              requirements                        rank      d   3.20
                                                              Rapid staff turnover                rank      e   3.00

                                                              Team members do not believe
                                                              in documenting their code           rank      f   3.80
                                                              Team members are
                                                              unmotivated to document their
                                                              code                                rank      g   4.00
                                                              Team members see little
                                                              benefit in always maintaining
                                                              supporting documents                rank      h   3.60
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.82
Software documentation is important, but in my
organization it is unfortunately not that useful.                                              14 opinion       2.27
Software documentation that I reference is easy to
understand, navigate and cross reference.                                                      15 opinion       3.83
The language / style of writing in software documentation
I reference is brief and to the point.                                                         16 opinion       3.42
When I am working on a software system and require
assistance, it is easy to locate the appropriate supporting
documentation.                                                                                 17 opinion       2.75
Tools to view and browse software documents are bulky
and inefficient.                                                                               18 opinion       2.64
Tools to view and browse software documents facilitate
my work.                                                                                       19 opinion       3.55
Documentation is always outdated relative to the current
state of a software system.                                                                    20 opinion       3.55
Software documentation can be useful even through it
might not always be the most up to date (relative the
system it documents).                                                                          21 opinion       3.33
Most software documents have a finite useful lifetime
and should be subsequently discarded (or removed from
the primary document repository).                                                              22 opinion       2.75
The cost of maintaining most software documents
greatly outweighs the benefits of having such documents
up to date.                                                                                    23 opinion       2.83
Software documentation contains a lot of information that
can be extracted directly from the system’s source code
itself.                                                                                        24 opinion       3.17
Tools that help extract information from source code (for
example JavaDoc) are extremely powerful for creating
supporting documentation.                                                                      25 opinion       4.00
Software documentation concentrates too heavily on
high level issues rather than the important
implementation details.                                      26 opinion         2.58
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.67
Much more effort is required to format / prepare software
documentation than the effort of providing the actual
content for the documents.                                   28 opinion         2.67
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         3.78
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.60
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.45
I would rather refactor / update / debug / test a system
then document it in its present (and flawed) state.
                                                             32 opinion         3.55
We use a useful configuration management system to
maintain our software documentation.                         33 opinion         3.60
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.18
Only a few software documents are personally useful to
me.                                                          35 opinion         3.92
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        4.00
                                                            Specifications                    rank       b        3.80
                                                            Detailed Design                   rank       c        3.40
                                                            Low Level Design                  rank       d        3.00
                                                            Architectural                     rank       e        3.40
                                                         Testing / Quality Documents          rank       f        3.60
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        4.00
                                                         Team members' pride in
                                                         project                              rank       b        3.60
                                                         Manager's satisfaction with the
                                                         projects progress                    rank       c        3.20
                                                            Customer Satisfaction             rank       d        3.40
                                                            Project delivery on time          rank       e        3.60
                                                         Project delivery on budget             rank       f              3.20
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.80
                                                         Writing style (Is it easier to
                                                         read and understand?)                  rank       b              3.40

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

                                                           Searching (Is it easier to find
                                                           the information you need?)           rank       d              3.20
                                                           Updated (Are the documents
                                                           more up to date?)                    rank       e              3.60
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        3.00
                                                         Have daily builds                    rank       b        2.20
                                                         Maintain a bug database              rank       c        3.40
                                                         Fix bugs before writing new
                                                         code                                 rank       d        4.20

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




--               --         --           --        --                9        75.0%    1
--               --         --           --        --                7        58.3%    1
--               --         --           --        --                5        41.7%    1
--               --         --           --        --                5        41.7%    1
--               --         --           --        --                7        58.3%    1
--               --         --           --        --                5        41.7%




          0.45          2            2         3         2           5 --
          0.55          2            2         3         2           5 --
          0.45          3            3         3         2           5 --
          0.71          3            3         4         2           5 --
          0.45          3            3         3         2           5 --
          0.45          2            2         3         2           5 --




          0.55          2            2         2         1           5 --
          1.10          2            2         4         1           5 --
          1.00          2            3         4         2           5 --
          0.84          4            3         4         2           5 --
          0.84          2            3         4         2           5 --
          1.10          2            2         4         2           5 --




          1.34          2            4         5         2           5 --
          1.41          2            2         5         2           5 --
          0.84          2            3         4         2           5 --
          1.10          2            2         4         1           5 --
          0.89          2            2         4         2           5 --
1.52   2   3   5   2   5 --




0.84   4   4   5   3   5 --
1.14   4   4   5   2   5 --
1.14   4   4   5   2   5 --
0.84   2   2   3   1   5 --
0.89   3   3   5   3   5 --
1.00   2   3   4   2   5 --




1.67   5   4   5   1   5 --
1.48   3   3   5   1   5 --
0.84   2   2   3   1   5 --
0.84   1   2   3   1   5 --
1.48   3   3   5   1   5 --
1.34   1   3   4   1   5 --




0.89   4   4   4   2   5 --

1.00   2   3   4   2   5 --

0.84   4   3   4   2   5 --



1.30   2   2   5   2   5 --




0.89   2   2   4   2   5 --



1.00   2   3   4   2   5 --



0.89   2   2   4   2   5 --

0.84   3   3   4   2   5 --



1.00   2   3   4   2   5 --




1.10   3   3   4   1   5 --

0.84   2   3   4   2   5 --
0.55          2    2    2   1   5 --




0.96          3   2.5   3   1   4 --

1.71   #N/A       2.5   5   1   4 --




1.41          4    4    4   1   5 --



0.84          4    4    5   3   5 --



0.55          3    3    4   3   5 --



1.10          2    2    4   2   5 --




0.71          3    3    4   2   5 --



1.14          2    2    4   1   5 --
1.52          4    4    5   1   5 --

0.00          5    5    5   5   5 --




0.71          4    4    5   3   5 --



1.67          1    2    5   1   5 --
0.45          3    3    4   3   5 --



0.55          3    3    4   3   5 --

0.71          4    4    5   3   5 --

1.14          2    2    4   1   5 --



1.14          4    4    5   2   5 --
0.89          5    5    5   3    5 --

0.89          3    3    5   3    5 --



1.58   #N/A        3    5   1    5 --

1.48          3    3    5   1    5 --
1.87          2    2    5   1    5 --



1.64          4    4    5   1    5 --



1.73          5    5    5   1    5 --



1.67          5    4    5   1    5 --




0.98          4    4    5   2   11 --   3      3

1.01          2    2    4   1   11 --   4 na

0.94          4    4    5   2   12 --   4      5

1.31          4    4    5   1   12 --   4      5


1.06          2   2.5   4   1   12 --   3      3

1.36          2    2    5   1   11 --   5 na

0.93          4    4    4   1   11 --   4 na

1.04          4    4    5   2   11 --   4 na


1.07          4    4    5   2   12 --   4      3


1.42          4   2.5   5   1   12 --   5      4


1.03          2   2.5   5   2   12 --   2      5


1.03          4    3    5   2   12 --   4      5


0.95          5    4    5   3   12 --   5      5
     1.24          2           2   5   1   12 --              2            4




     1.30          4           4   5   1   12 --              5            4


     1.50          2           2   5   1   12 --              4            5




     0.97          4           4   5   2    9 --   na                      5


     1.07          4           4   5   2   10 --              3            5


     0.69          5           5   5   3   11 --              5            3


     1.04          4           4   5   2   11 --              4            5

     1.51          4           4   5   1   10 --              5            5




     1.17          4           4   4   1   11 --              4 na

     0.79          4           4   5   2   12 --              4            4




#DIV/0!     #N/A       #NUM!       0   0    0 --                JavaDoc
                                                   JavaDoc Rational Roseand any word processor. All our d
#DIV/0!     #N/A       #NUM!       0   0   0 --   Word Acrobat Excel and powerpoint. I've used them but it




     1.00          3           4   5   3   5 --
     1.10          3           3   5   3   5 --
     0.55          3           3   4   3   5 --
     0.71          3           3   4   2   5 --
     0.55          3           3   4   3   5 --
     0.89          3           3   5   3   5 --




     0.71          4           4   5   3   5 --

     1.14          4           4   5   2   5 --

     1.30          2           3   5   2   5 --
     1.14          3           3   5   2   5 --
     1.14          4           4   5   2   5 --
          1.30               2                3        5        2   5 --




          0.84               4                4        5        3   5 --

          0.55               3                3        4        3   5 --



          0.71               3                3        4        2   5 --



          1.10               3                3        5        2   5 --

          0.89               3                3        5        3   5 --

--               --              --               --       --       0       0.0%
--               --              --               --       --       0       0.0%
--               --              --               --       --       4      33.3%                              1
--               --              --               --       --       1       8.3%
--               --              --               --       --       3      25.0%                1
--               --              --               --       --       3      25.0%
--               --              --               --       --       1       8.3%

--               --              --               --       --       0       0.0%
--               --              --               --       --       1       8.3%
--               --              --               --       --       0       0.0%
--               --              --               --       --       11     91.7%                1             1




     #DIV/0!          #N/A            #NUM!            0        0   0 --                          Finicial Services. We in currently lives, an
                                                                                    A unique software integration toolkit areone of my focused
--               --              --               --       --       12     100.0%               1             1
--               --              --               --       --       5      41.7%                              1
--               --              --               --       --       7      58.3%                1             1
--               --              --               --       --       5      41.7%
--               --              --               --       --       0       0.0%
--               --              --               --       --       1       8.3%
--               --              --               --       --       1       8.3%
--               --              --               --       --       1       8.3%
--               --              --               --       --       0       0.0%
--               --              --               --       --       1       8.3%
--               --              --               --       --       1       8.3%
--               --              --               --       --       7      58.3%                              1
--               --              --               --       --       10     83.3%                1             1
--               --              --               --       --       5      41.7%                              1
--               --              --               --       --       9      75.0%                1             1
--               --              --               --       --       10     83.3%                1             1
--               --              --               --       --       2      16.7%
--               --              --               --       --       2      16.7%                              1
--               --              --               --       --       1       8.3%
--          --       --       --       --       0      0.0%

--          --       --       --       --       1      8.3%
--          --       --       --       --       5      41.7%   1
--          --       --       --       --       0      0.0%
--          --       --       --       --       3      25.0%
--          --       --       --       --       1      8.3%        1
--          --       --       --       --       1      8.3%
--          --       --       --       --       0      0.0%
--          --       --       --       --       0      0.0%
--          --       --       --       --       0      0.0%
--          --       --       --       --       1      8.3%
--          --       --       --       --       7      58.3%   1
--          --       --       --       --       3      25.0%   1
--          --       --       --       --       0      0.0%




     1.87        2        2        5        1   5 --
     1.64        2        2        5        1   5 --
     1.14        3        3        5        2   5 --

     0.84        5        4        5        3   5 --

     1.14        3        3        5        2   5 --

     1.41        5        5        5        2   5 --



     1.79        1        1        5        1   5 --
     0.84        4        4        5        3   5 --




     1.30        4        3        4        1   5 --
189   212   221   229   235   246   251   10   11




 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     2     3               2
 2                 2     2     3               3
 2                 3     3     3               3
 2                 3     3     4               3
 2                 3     3     3               3
 2                 2     2     3               2




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




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




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



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




2   4   4   4   4

2   4   3   2   4

2   4   3   4   3


2   5   3   2   2




2   4   2   2   2


2   4   4   3   2


2   2   2   2   4

2   3   4   4   3


2   4   3   2   4




1   3   4   3   3

2   2   3   3   4
1   2   2      1   2



1   3   2 na       3

2   3   1 na       5




4   4   4      1   2


4   3   4      5   3


4   3   4      3   3


4   2   2      2   4



4   3   3      2   3


3   2   1      2   4
5   1   4      4   3

5   5   5      5   5



4   3   4      5   4


1   2   3      5   1
3   3   3      3   4


3   3   4      3   4

3   4   4      5   4

1   4   2      3   2


5   4   2      3   4
5           3   5   5           5

3           3   5   4           3


1           5   4   3           2

3           3   4   1           5
2           2   5   1           5


4           1   4   5           5


5           1   4   5           5


3           1   4   5           5




5   4   3   4   4   5   5       4

3   4   2   1   2   2   2   2   1

4   4   4   5   4   2   2   4   4

1   2   4   5   4   4   2   2   4


1   2   4   4   2   2   2   4   4

1   2   1   3   3   5   3   2   2

4   4   4   4   3   1   3   4   4

5   4   2   4   2   4   2   4   4


4   4   2   2   4   4   2   2   5


1   2   4   4   2   3   4   1   1


4   2   2   3   2   3   2   3   2


2   2   3   4   2   3   3   2   4


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



           1             4             5             5             4             4               2              4            4


           1             1             1             4             3             5               2              2            2




           4             2             4             5             4             3 na                na                      4


           4             4             4             5 na                        2               2   na                      4


           4             4             5             4             5             5                              5            5


           3             2             4             4             5             3               4   na                      2

na                       4             4             1             5             1               4   na                      3




           1             4             2             4             4             4               4              4            2

           5             4             3             4             4             2               4              4            5


                                                                      We are
                                                                      currently
                                                                      using the
                                                                      System
                                                                      Architect
                                                                      CASE tool
                                                                      from Popkin,
                                                                      a word
                                                                      processor
                                                                      and standard
                                                                      folder-based
                                                                      storage.
                                                                      These
                                                                      methods do
                                                                      not work
                                                                      well. If (!)
                                                                      toolsets were
                                                         Word         stable, I       We have
                                                         processors, would prefer     standard
                                           Word          design/      documentati     templates in                  XML
                                           Processors, modelling      on tools tied   various word
                                                                                                     Word           editor and
                                           JavaDoc,      tools,       closely to my   processing
                                           diagramming requirements software          formats. I     Visio          custom
                                           tools like    traceability development     use MS         Rational       tools
Text editor or Web browser. Notes JavaDoc FreeLance tools. sometimes.
               Proprietary Reviewing Tools Visio Acrobat or Word
                             PowerPoint. Adobe                        tools.          Word.          Rose           Doc++
                                                                             Though
                                                                             funded for it,
                                                                             I chose not
                                                                             to introduce
                                                                             automated
                                                                             testing. I
                                                                             believe the
                                                                             time to learn
                                                                             the testing
                                                                             tool would
                                                                             outweigh the
                                                                             benefits of
                                                                             being able to
                                                                             run the tests
                                                                             automatically
                                                                             . Partly
                                                                             because I
                                                                             was able to
                                                                             hire a very
                                                                             capable
                                                                             student
                                                                             assistant to
                                                                             run the tests.
                                                                             95% or more
                                                                             of the work is
                                                                             in writing the
                                                                             test scripts.
                                                                             They have to
                                                                             be modified
                                           Word                              each time as
                                           Processors,                       the
                                           Visio They                        application is
                                           can be good                       changed.
                                           or bad                            This takes
                                           depending                         people-
                                           on the user                       power even
                                           and what                          with an          Text/html
                                           they are        Auto              automated        editors/W
                            collect the right information. generators.
Automated tools. They don't vi             writing                           tool.            P




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



            4                                           4                3               4            5

            4                                           4                2               3            5

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



           4                                       3               3            4                                     5

           4                                       3               3            3                                     4


           3                                       2               3            3                                     4


           3                                       2               3            5                                     3

           3                                       3               3            4                                     5



           1                                                                    1           1
                                                                   1
                                                   1                                                                  1
                        1             1
                                                                                                         1


                                                   1


           1            1             1                            1            1           1            1             1
                                                                                                             small
                                                                                                 XML-        company,
                                                                                   Database      based       provides
                                                        Real-time    Internal      and related
                                                                                                 email plug- solutions
                                                        embedded     applications applications
                                        Web             systems for supporting     (products,    in Email    using our
                                        Solutions, e-   defence /    the           support,      marketing core
                                        Commerce
              software R&DDatabase applications
motion pictureC/C++ Compilers & Class Libraries         aerospace. department. consulting) services          product
            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




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

5           4   3   5           4

2           3   5   3           4

5           3   5   2           5


5           1   1   1           3
4           4   3   5           3



4           4   1   3           2
23




1
1



1
2

2

4

4


2

2

4

4


4


2


4


4


3
1



2


2




3


3


4


3

4




2

4
        1




        1



ATM
Edge and
Core
switches
         1




        1

        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.00    0.00          1            0
                                                                                0.80    0.80          2            4
                                                                                0.20    0.20          3            1
                                                                                0.00    0.00          4            0
                                                                                0.00    0.00          5            0
                                                                                0.00    0.00 na                    0
                                                       Specifications                          rank       b
                                                                                0.00    0.00          1            0
                                                                                0.60    0.60          2            3
                                                                                0.40    0.40          3            2
                                                                                0.00    0.00          4            0
                                                                                0.00    0.00          5            0
                                                                                0.00    0.00 na                    0
                                                       Detailed Design                         rank       c
                                                                                0.00    0.00          1            0
                                                                                0.20    0.20          2            1
                                                                                0.80    0.80          3            4
                                                                                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.20    0.20          2            1
                                                                                0.60    0.60          3            3
                                                                                0.20    0.20          4            1
                                                                                0.00    0.00          5            0
                                                                                0.00    0.00 na                    0
                                                       Architectural                           rank       e
                                                                                0.00    0.00          1            0
                                                                                0.20    0.20          2            1
                                                                                0.80    0.80          3            4
                                                                                0.00    0.00          4            0
                                                                                0.00    0.00          5            0
                                                                                0.00    0.00 na                    0
                                                       Testing / Quality Documents             rank       f
                                                                                0.00    0.00          1            0
                                                                                0.80    0.80          2            4
                                                                                0.20    0.20          3            1
                                                                                0.00    0.00          4            0
                                                                                0.00    0.00          5            0
                                                                                0.00    0.00 na                    0
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.40   0.40          1       2
                                                                          0.60   0.60          2       3
                                                                          0.00   0.00          3       0
                                                                          0.00   0.00          4       0
                                                                          0.00   0.00          5       0
                                                                          0.00   0.00 na               0
                                                 Specifications                         rank       b
                                                                          0.20   0.20          1       1
                                                                          0.60   0.60          2       3
                                                                          0.00   0.00          3       0
                                                                          0.20   0.20          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.40   0.40          2       2
                                                                          0.20   0.20          3       1
                                                                          0.40   0.40          4       2
                                                                          0.00   0.00          5       0
                                                                          0.00   0.00 na               0
                                                 Low Level Design                       rank       d
                                                                          0.00   0.00          1       0
                                                                          0.20   0.20          2       1
                                                                          0.40   0.40          3       2
                                                                          0.40   0.40          4       2
                                                                          0.00   0.00          5       0
                                                                          0.00   0.00 na               0
                                                 Architectural                          rank       e
                                                                          0.00   0.00          1       0
                                                                          0.40   0.40          2       2
                                                                          0.40   0.40          3       2
                                                                          0.20   0.20          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.60   0.60          2       3
                                                                          0.00   0.00          3       0
                                                                          0.40   0.40          4       2
                                                                          0.00   0.00          5       0
                                                                          0.00   0.00 na               0
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.40   0.40          2       2
                                                                                     0.00   0.00          3       0
                                                                                     0.40   0.40          4       2
                                                                                     0.20   0.20          5       1
                                                                                     0.00   0.00 na               0
                                                            Specifications                         rank       b
                                                                                     0.00   0.00          1       0
                                                                                     0.60   0.60          2       3
                                                                                     0.00   0.00          3       0
                                                                                     0.20   0.20          4       1
                                                                                     0.20   0.20          5       1
                                                                                     0.00   0.00 na               0
                                                            Detailed Design                        rank       c
                                                                                     0.00   0.00          1       0
                                                                                     0.40   0.40          2       2
                                                                                     0.40   0.40          3       2
                                                                                     0.20   0.20          4       1
                                                                                     0.00   0.00          5       0
                                                                                     0.00   0.00 na               0
                                                            Low Level Design                       rank       d
                                                                                     0.20   0.20          1       1
                                                                                     0.60   0.60          2       3
                                                                                     0.00   0.00          3       0
                                                                                     0.20   0.20          4       1
                                                                                     0.00   0.00          5       0
                                                                                     0.00   0.00 na               0
                                                            Architectural                          rank       e
                                                                                     0.00   0.00          1       0
                                                                                     0.60   0.60          2       3
                                                                                     0.20   0.20          3       1
                                                                                     0.20   0.20          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.40   0.40          2       2
                                                                                     0.20   0.20          3       1
                                                                                     0.00   0.00          4       0
                                                                                     0.40   0.40          5       2
                                                                                     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.00   0.00          1       0
                                                                                     0.00   0.00          2       0
                                                                                     0.40   0.40          3       2
                                                                                     0.40   0.40          4       2
                                                                                     0.20   0.20          5       1
                                                                                     0.00   0.00 na               0
                                                            Specifications                         rank       b
                                                                                     0.00   0.00          1       0
                                                                                     0.20   0.20          2       1
                                                                                     0.20   0.20          3       1
                                                                                     0.40   0.40          4       2
                                                                                     0.20   0.20          5       1
                                                                                     0.00   0.00 na               0
                                                            Detailed Design                        rank       c
                                                                                     0.00   0.00          1       0
                                                                                     0.20   0.20          2       1
                                                                                     0.20   0.20          3       1
                                                                                     0.40   0.40          4       2
                                                                                     0.20   0.20          5       1
                                                                                     0.00   0.00 na               0
                                                            Low Level Design                       rank       d
                                                                                     0.20   0.20          1       1
                                                                                     0.40   0.40          2       2
                                                                                     0.40   0.40          3       2
                                                                                     0.00   0.00          4       0
                                                                                     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.60   0.60          3       3
                                                                                     0.20   0.20          4       1
                                                                                     0.20   0.20          5       1
                                                                                     0.00   0.00 na               0
                                                            Testing / Quality Documents            rank       f
                                                                                     0.00   0.00          1       0
                                                                                     0.40   0.40          2       2
                                                                                     0.20   0.20          3       1
                                                                                     0.40   0.40          4       2
                                                                                     0.00   0.00          5       0
                                                                                     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.20   0.20          1       1
                                                                                     0.00   0.00          2       0
                                                                                     0.20   0.20          3       1
                                                                              0.20   0.20          4       1
                                                                              0.40   0.40          5       2
                                                                              0.00   0.00 na               0
                                                     Specifications                         rank       b
                                                                              0.20   0.20          1       1
                                                                              0.00   0.00          2       0
                                                                              0.40   0.40          3       2
                                                                              0.20   0.20          4       1
                                                                              0.20   0.20          5       1
                                                                              0.00   0.00 na               0
                                                     Detailed Design                        rank       c
                                                                              0.20   0.20          1       1
                                                                              0.40   0.40          2       2
                                                                              0.40   0.40          3       2
                                                                              0.00   0.00          4       0
                                                                              0.00   0.00          5       0
                                                                              0.00   0.00 na               0
                                                     Low Level Design                       rank       d
                                                                              0.40   0.40          1       2
                                                                              0.40   0.40          2       2
                                                                              0.20   0.20          3       1
                                                                              0.00   0.00          4       0
                                                                              0.00   0.00          5       0
                                                                              0.00   0.00 na               0
                                                     Architectural                          rank       e
                                                                              0.20   0.20          1       1
                                                                              0.20   0.20          2       1
                                                                              0.40   0.40          3       2
                                                                              0.00   0.00          4       0
                                                                              0.20   0.20          5       1
                                                                              0.00   0.00 na               0
                                                     Testing / Quality Documents            rank       f
                                                                              0.40   0.40          1       2
                                                                              0.00   0.00          2       0
                                                                              0.40   0.40          3       2
                                                                              0.20   0.20          4       1
                                                                              0.00   0.00          5       0
                                                                              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.20   0.20          2       1
                                                                              0.00   0.00          3       0
                                                                              0.80   0.80          4       4
                                                                              0.00   0.00          5       0
                                                                              0.00   0.00 na               0
                                                     When MAINTAINING a
                                                     software system.                       rank       b
                                                                              0.00   0.00          1       0
                                                                              0.40   0.40          2       2
                          0.20   0.20          3       1
                          0.40   0.40          4       2
                          0.00   0.00          5       0
                      0.00       0.00 na               0
When TESTING a software
system.                                 rank       c
                          0.00   0.00          1       0
                          0.20   0.20          2       1
                          0.40   0.40          3       2
                          0.40   0.40          4       2
                          0.00   0.00          5       0
                          0.00   0.00 na               0
When other developers are
UNAVAILABLE to answer my
questions.                              rank       d
                          0.00   0.00          1       0
                          0.60   0.60          2       3
                          0.20   0.20          3       1
                          0.00   0.00          4       0
                          0.20   0.20          5       1
                          0.00   0.00 na               0

When explaining / answering
questions about the system to
MANAGEMENT or
CUSTOMERS.                              rank       f
                          0.00   0.00          1       0
                          0.80   0.80          2       4
                          0.00   0.00          3       0
                          0.20   0.20          4       1
                          0.00   0.00          5       0
                          0.00   0.00 na               0
When looking for BIG-
PICTURE information about
the software system                     rank       g
                          0.00   0.00          1       0
                          0.40   0.40          2       2
                          0.20   0.20          3       1
                          0.40   0.40          4       2
                          0.00   0.00          5       0
                          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.80   0.80          2       4
                          0.00   0.00          3       0
                          0.20   0.20          4       1
                          0.00   0.00          5       0
                       0.00      0.00 na               0
When working with a NEW
software system                         rank       i
                          0.00   0.00          1       0
                          0.20   0.20          2       1
                                                                                         0.40   0.40          3       2
                                                                                         0.40   0.40          4       2
                                                                                         0.00   0.00          5       0
                                                                                         0.00   0.00 na               0
                                                              When working with an
                                                              ESTABLISHED / MATURE
                                                              software systems                         rank       j
                                                                                         0.00   0.00          1       0
                                                                                         0.40   0.40          2       2
                                                                                         0.20   0.20          3       1
                                                                                         0.40   0.40          4       2
                                                                                         0.00   0.00          5       0
                                                                                         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.20   0.20          1       1
                                                                                         0.00   0.00          2       0
                                                                                         0.60   0.60          3       3
                                                                                         0.20   0.20          4       1
                                                                                         0.00   0.00          5       0
                                                                                         0.00   0.00 na               0
                                                              Mature projects with new
                                                              functionality                            rank       b
                                                                                         0.00   0.00          1       0
                                                                                         0.40   0.40          2       2
                                                                                         0.40   0.40          3       2
                                                                                         0.20   0.20          4       1
                                                                                         0.00   0.00          5       0
                                                                                         0.00   0.00 na               0

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

                                                              Agile or lightweight projects
                                                              (for example eXtreme projects,
                                                              extremeprogramming.org)                  rank       d
                                                                                         0.25   0.20          1       1
                                                                                         0.25   0.20          2       1
                                                                                         0.50   0.40          3       2
                                                                                         0.00   0.00          4       0
                                                                                         0.00   0.00          5       0
                                                                                    0.25        0.20 na               1
                                                           Open source, public domain
                                                           projects                                    rank       e
                                                                                         0.25   0.20          1       1
                                                                                         0.25   0.20          2       1
                                                                                         0.25   0.20          3       1
                                                                                         0.00   0.00          4       0
                                                                                         0.25   0.20          5       1
                                                                                         0.25   0.20 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.20   0.20          1       1
                                                                                         0.20   0.20          2       1
                                                                                         0.00   0.00          3       0
                                                                                         0.60   0.60          4       3
                                                                                         0.00   0.00          5       0
                                                                                         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.40   0.40          3       2
                                                                                         0.40   0.40          4       2
                                                                                         0.20   0.20          5       1
                                                                                         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.60   0.60          3       3
                                                                                         0.40   0.40          4       2
                                                                                         0.00   0.00          5       0
                                                                                         0.00   0.00 na               0
                                                           Navigation (internal / external
                                                           links, actual links or just
                                                           references)                                 rank       d
                                                                                         0.00   0.00          1       0
                                                                                         0.60   0.60          2       3
                                                                                         0.00   0.00          3       0
                                                                                         0.40   0.40          4       2
                                                                                         0.00   0.00          5       0
                                                                                         0.00   0.00 na               0

                                                           Document structure
                                                           (arrangement of text, tables,
                                                           figures and diagrams)                       rank       e
                                                                                         0.00   0.00          1       0
                            0.20   0.20          2       1
                            0.60   0.60          3       3
                            0.20   0.20          4       1
                            0.00   0.00          5       0
                            0.00   0.00 na               0
Document's format (i.e.
Microsoft Word, Note Pad,
Visio, Html, Pdf)                         rank       f
                            0.20   0.20          1       1
                            0.40   0.40          2       2
                            0.20   0.20          3       1
                            0.20   0.20          4       1
                            0.00   0.00          5       0
                            0.00   0.00 na               0
Author                                    rank       g
                            0.20   0.20          1       1
                            0.00   0.00          2       0
                            0.20   0.20          3       1
                            0.40   0.40          4       2
                            0.20   0.20          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.00   0.00          4       0
                            1.00   1.00          5       5
                            0.00   0.00 na               0

Type (requirements,
specification, detailed design,
architectural document)                   rank       j
                            0.00   0.00          1       0
                            0.00   0.00          2       0
                            0.20   0.20          3       1
                            0.60   0.60          4       3
                            0.20   0.20          5       1
                            0.00   0.00 na               0
Influence from management /
project leaders / other
developers to use it                      rank       k
                            0.40   0.40          1       2
                            0.20   0.20          2       1
                            0.20   0.20          3       1
                            0.00   0.00          4       0
                            0.20   0.20          5       1
                            0.00   0.00 na               0
Spelling and grammar                      rank       l
                            0.00   0.00          1       0
                            0.00   0.00          2       0
                            0.80   0.80          3       4
                            0.20   0.20          4       1
                                                                                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.00   0.00          2       0
                                                                                0.60   0.60          3       3
                                                                                0.40   0.40          4       2
                                                                                0.00   0.00          5       0
                                                                                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.20   0.20          3       1
                                                                                0.60   0.60          4       3
                                                                                0.20   0.20          5       1
                                                                             0.00      0.00 na               0
                                                    Use of modelling diagrams
                                                    (UML, SDL, etc)                           rank       o
                                                                                0.20   0.20          1       1
                                                                                0.40   0.40          2       2
                                                                                0.20   0.20          3       1
                                                                                0.20   0.20          4       1
                                                                                0.00   0.00          5       0
                                                                                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.20   0.20          2       1
                                                                                0.20   0.20          3       1
                                                                                0.40   0.40          4       2
                                                                                0.20   0.20          5       1
                                                                                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.00   0.00          2       0
                                                                                0.20   0.20          3       1
                                                                                0.00   0.00          4       0
                                                                                0.80   0.80          5       4
                                                                                0.00   0.00 na               0
                                                    Budget constraints on the
                                                    project                                   rank       b
                                                                                0.00   0.00          1       0
                                                                                0.00   0.00          2       0
                                                                                0.60   0.60          3       3
                                                                                0.20   0.20          4       1
                                                                                0.20   0.20          5       1
                          0.00   0.00 na               0
High costs of maintaining
documentation is not worth the
effort                                  rank       c
                          0.20   0.20          1       1
                          0.20   0.20          2       1
                          0.20   0.20          3       1
                          0.20   0.20          4       1
                          0.20   0.20          5       1
                          0.00   0.00 na               0
Rapid changes in
requirements                            rank       d
                          0.20   0.20          1       1
                          0.00   0.00          2       0
                          0.40   0.40          3       2
                          0.20   0.20          4       1
                          0.20   0.20          5       1
                          0.00   0.00 na               0
Rapid staff turnover                    rank       e
                          0.20   0.20          1       1
                          0.40   0.40          2       2
                          0.00   0.00          3       0
                          0.00   0.00          4       0
                          0.40   0.40          5       2
                          0.00   0.00 na               0

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



                          0.20   0.20          1       1



                          0.00   0.00          2       0
                                                                               0.20   0.20          3       1



                                                                               0.20   0.20          4       1



                                                                               0.40   0.40          5       2



                                                                               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.00   0.00          1       0
                                                                               0.00   0.00          2       0
                                                                               0.40   0.40          3       2
                                                                               0.20   0.20          4       1
                                                                               0.40   0.40          5       2
                                                                               0.00   0.00 na               0
                                                            Specifications                   rank       b
                                                                               0.00   0.00          1       0
                                                                               0.00   0.00          2       0
                                                                               0.60   0.60          3       3
                                                                               0.00   0.00          4       0
                                                                               0.40   0.40          5       2
                                                                               0.00   0.00 na               0
                                                            Detailed Design                  rank       c
                                                                               0.00   0.00          1       0
                                                                               0.00   0.00          2       0
                                                                               0.60   0.60          3       3
                                                                               0.40   0.40          4       2
                                                                               0.00   0.00          5       0
                                                                               0.00   0.00 na               0
                                                            Low Level Design                 rank       d
                                                                               0.00   0.00          1       0
                                                                               0.20   0.20          2       1
                                                                               0.60   0.60          3       3
                                                                               0.20   0.20          4       1
                                                                               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.60   0.60          3       3
                                                                               0.40   0.40          4       2
                                                                               0.00   0.00          5       0
                                                                               0.00   0.00 na               0
                                                         Testing / Quality Documents                 rank       f
                                                                                       0.00   0.00          1       0
                                                                                       0.00   0.00          2       0
                                                                                       0.60   0.60          3       3
                                                                                       0.20   0.20          4       1
                                                                                       0.20   0.20          5       1
                                                                                       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.00   0.00          2       0
                                                                                       0.20   0.20          3       1
                                                                                       0.60   0.60          4       3
                                                                                       0.20   0.20          5       1
                                                                                       0.00   0.00 na               0
                                                         Team members' pride in
                                                         project                                     rank       b
                                                                                       0.00   0.00          1       0
                                                                                       0.20   0.20          2       1
                                                                                       0.20   0.20          3       1
                                                                                       0.40   0.40          4       2
                                                                                       0.20   0.20          5       1
                                                                                    0.00      0.00 na               0
                                                         Manager's satisfaction with the
                                                         projects progress                           rank       c
                                                                                       0.00   0.00          1       0
                                                                                       0.40   0.40          2       2
                                                                                       0.20   0.20          3       1
                                                                                       0.20   0.20          4       1
                                                                                       0.20   0.20          5       1
                                                                                       0.00   0.00 na               0
                                                         Customer Satisfaction                       rank       d
                                                                                       0.00   0.00          1       0
                                                                                       0.20   0.20          2       1
                                                                                       0.40   0.40          3       2
                                                                                       0.20   0.20          4       1
                                                                                       0.20   0.20          5       1
                                                                                       0.00   0.00 na               0
                                                         Project delivery on time                    rank       e
                                                                                       0.00   0.00          1       0
                                                                                       0.20   0.20          2       1
                                                                                       0.20   0.20          3       1
                                                                                       0.40   0.40          4       2
                                                                                       0.20   0.20          5       1
                                                                                       0.00   0.00 na               0
                                                         Project delivery on budget                  rank       f
                                                                                       0.00   0.00          1       0
                                                                                       0.40   0.40          2       2
                                                                                       0.20   0.20          3       1
                                                                                       0.20   0.20          4       1
                                                                                       0.20   0.20          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.00    0.00          2       0
                                                                                     0.40    0.40          3       2
                                                                                     0.40    0.40          4       2
                                                                                     0.20    0.20          5       1
                                                                                      0.00   0.00 na               0
                                                        Writing style (Is it easier to
                                                        read and understand?)                       rank       b
                                                                                     0.00    0.00          1       0
                                                                                     0.00    0.00          2       0
                                                                                     0.60    0.60          3       3
                                                                                     0.40    0.40          4       2
                                                                                     0.00    0.00          5       0
                                                                                     0.00    0.00 na               0

                                                        Navigation (Is it easier to
                                                        move between documents?)                    rank       c
                                                                                     0.00    0.00          1       0
                                                                                     0.20    0.20          2       1
                                                                                     0.60    0.60          3       3
                                                                                     0.20    0.20          4       1
                                                                                     0.00    0.00          5       0
                                                                                     0.00    0.00 na               0

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


                                                                                     0.00    0.00          1       0


                                                                                     0.20    0.20          2       1


                                                                                     0.60    0.60          3       3


                                                                                     0.00    0.00          4       0


                                                                                     0.20    0.20          5       1


                                                                                     0.00    0.00 na               0
                                                        Updated (Are the documents
                                                        more up to date?)                           rank       e

                                                                                     0.00    0.00          1       0

                                                                                     0.00    0.00          2       0
                                                                                     0.60   0.60          3       3

                                                                                     0.20   0.20          4       1

                                                                                     0.20   0.20          5       1

                                                                                    0.00    0.00 na               0
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.20   0.20          1       1
                                                                                     0.40   0.40          2       2
                                                                                     0.00   0.00          3       0
                                                                                     0.00   0.00          4       0
                                                                                     0.40   0.40          5       2
                                                                                     0.00   0.00 na               0
                                                         Have daily builds                         rank       b
                                                                                     0.40   0.40          1       2
                                                                                     0.40   0.40          2       2
                                                                                     0.00   0.00          3       0
                                                                                     0.00   0.00          4       0
                                                                                     0.20   0.20          5       1
                                                                                     0.00   0.00 na               0
                                                         Maintain a bug database                   rank       c
                                                                                     0.00   0.00          1       0
                                                                                     0.20   0.20          2       1
                                                                                     0.40   0.40          3       2
                                                                                     0.20   0.20          4       1
                                                                                     0.20   0.20          5       1
                                                                                    0.00    0.00 na               0
                                                         Fix bugs before writing new
                                                         code                                      rank       d
                                                                                     0.00   0.00          1       0
                                                                                     0.00   0.00          2       0
                                                                                     0.20   0.20          3       1
                                                                                     0.40   0.40          4       2
                                                                                     0.40   0.40          5       2
                                                                                     0.00   0.00 na               0

                                                         Keep an up-to-date schedule               rank       e
                                                                                     0.00   0.00          1       0
                                                                                     0.20   0.20          2       1
                                                                                     0.40   0.40          3       2
                                                                                     0.20   0.20          4       1
                                                                                     0.20   0.20          5       1
                                                                                     0.00   0.00 na               0
                                                         Have a specifications
                                                         document for your project                 rank       f
                                                                                     0.00   0.00          1       0
                                                                                     0.20   0.20          2       1
                          0.20    0.20          3       1
                          0.00    0.00          4       0
                          0.60    0.60          5       3
                          0.00    0.00 na               0
Have new candidates for the
development team write code
during the interview                     rank       h
                          0.60    0.60          1       3
                          0.00    0.00          2       0
                          0.20    0.20          3       1
                          0.00    0.00          4       0
                          0.20    0.20          5       1
                          0.00    0.00 na               0
Have testers                             rank       j
                          0.00    0.00          1       0
                          0.00    0.00          2       0
                          0.40    0.40          3       2
                          0.40    0.40          4       2
                          0.20    0.20          5       1
                          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.20   0.20          1       1
                           0.20   0.20          2       1
                           0.20   0.20          3       1
                           0.40   0.40          4       2
                           0.00   0.00          5       0
                           0.00   0.00 na               0
166   189   212   221   229   235   246   251   10




       2                 2     2     3




       2                 2     2     3




       2                 3     3     3




       2                 3     3     4




       2                 3     3     3




       2                 2     2     3
2   1   2   1




2   1   2   4




2   4   3   4




2   4   3   4




2   4   3   2




2   4   2   2
2   2   4   4




2   2   4   2




2   2   3   3




2   2   2   1




2   2   3   2




2   2   3   5
5   4   4   3




5   3   4   2




2   4   3   5




2   3   2   1




5   3   3   3




2   4   2   4




1   3   5   5
1   3   5   3




1   2   2   3




1   2   1   2




1   2   3   5




1   3   1   4




2   4   4   4




2   4   3   2
2   4   3   4




2   5   3   2




2   4   2   2




2   4   4   3




2   2   2   2




2   3   4   4
2   4   3      2




1   3   4      3




2   2   3      3




1   2   2      1




1   3   2 na
2   3   1 na




4   4   4      1




4   3   4      5




4   3   4      3




4   2   2      2




4   3   3      2
3   2   1   2




5   1   4   4




5   5   5   5




4   3   4   5




1   2   3   5




3   3   3   3
3   3   4   3




3   4   4   5




1   4   2   3




5   4   2   3




5   3   5   5




3   3   5   4
1   5   4   3




3   3   4   1




2   2   5   1




4   1   4   5




5   1   4   5




3   1   4   5
3   5   3   5




3   5   3   3




3   3   3   4




3   3   3   2




3   3   3   4
3   4   3   5




4   4   3   4




4   4   2   3




2   4   2   3




2   4   3   3




2   4   3   4




2   4   2   3
4   3   3   4




4   3   3   3




3   2   3   3




3   2   3   5




3   3   3   4
2   1   5   2




2   2   1   1




3   3   5   2




5   4   3   5




2   3   5   3




5   3   5   2
5   1   1   1




4   4   3   5




4   4   1   3
11   23




2




3




3




3




3




2
2




2




2




3




3




4
5




5




4




4




4




5
3




4




4




3




4




3




4
4




3




3




3




3




4




4
3




2




2




2




4




3
4




3




4




2




3
5




2




3




3




4




3
4




3




5




4




1




4
4




4




2




4




5




3
2




5




5




5




5




5
4




5




4




4




4
3




5




5




5




5




5




5
5




4




4




3




5
5




5




4




4




4




5
3




3




2
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            0
                                                                                       2            1
                                                                                       3            3
                                                                                       4            4
                                                                                       5            3
                                                                              na                    0
Software documentation is important, but in my
organization it is unfortunately not that useful.                         14 opinion                     4
                                                                                       1            2
                                                                                       2            6
                                                                                       3            1
                                                                                       4            2
                                                                                       5            0
                                                                              na                    1
Software documentation that I reference is easy to
understand, navigate and cross reference.                                 15 opinion                     4
                                                                                       1            0
                                                                                       2            2
                                                                                       3            0
                                                                                       4            8
                                                                                       5            2
                                                                              na                    0
The language / style of writing in software documentation
I reference is brief and to the point.                                    16 opinion                     4
                                                                                       1            1
                                                                                       2            3
                                                                                       3            0
                                                                                       4            6
                                                                                       5            2
                                                                              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            5
                                                                                       3            2
                                                                                       4            4
                                                                                       5            0
                                                                              na                    0
Tools to view and browse software documents are bulky
and inefficient.                                                          18 opinion                     5
                                                                                       1            2
                                                                                       2            4
                                                                                       3            3
                                                                                       4            0
                                                                                       5            2
                                                                              na                    1
Tools to view and browse software documents facilitate
my work.                                                    19 opinion                   4
                                                                         1   1
                                                                         2   0
                                                                         3   2
                                                                         4   8
                                                                         5   0
                                                               na            1
Documentation is always outdated relative to the current
state of a software system.                                 20 opinion                   4
                                                                         1   0
                                                                         2   3
                                                                         3   0
                                                                         4   7
                                                                         5   1
                                                               na            1
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   4
                                                                         3   1
                                                                         4   6
                                                                         5   1
                                                               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   3
                                                                         2   3          50
                                                                         3   1          12
                                                                         4   4   41.6666667
                                                                         5   1
                                                               na            0
The cost of maintaining most software documents
greatly outweighs the benefits of having such documents
up to date.                                                 23 opinion                   2
                                                                         1   0
                                                                         2   6
                                                                         3   3
                                                                         4   2
                                                                         5   1
                                                               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   0
                                                                         2   4
                                                                         3   3
                                                                         4   4
                                                                         5   1
                                                               na            0
Tools that help extract information from source code (for
example JavaDoc) are extremely powerful for creating
supporting documentation.                                    25 opinion                5
                                                                          1   0
                                                                          2   0
                                                                          3   5
                                                                          4   2
                                                                          5   5
                                                                na            0
Software documentation concentrates too heavily on
high level issues rather than the important
implementation details.                                      26 opinion                2
                                                                          1   2
                                                                          2   5
                                                                          3   2
                                                                          4   2
                                                                          5   1
                                                                na            0
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   1
                                                                          2   2        25
                                                                          3   0        12
                                                                          4   6        75
                                                                          5   3
                                                                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   3
                                                                          2   4
                                                                          3   1
                                                                          4   2
                                                                          5   2
                                                                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   0
                                                                          2   1
                                                                          3   2
                                                                          4   4
                                                                          5   2
                                                                na            3
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   0
                                                                          2   2
                                                                          3   2
                                                                          4   4
                                                                          5   2
                                                                na            2
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   0
                                                                          2   0
                                                                          3   1
                                                                          4   4
                                                                          5   6
                                                                na            0
I would rather refactor / update / debug / test a system
then document it in its present (and flawed) state.
                                                             32 opinion           4
                                                                          1   0
                                                                          2   2
                                                                          3   3
                                                                          4   4
                                                                          5   2
                                                                na            1
We use a useful configuration management system to
maintain our software documentation.                         33 opinion           5
                                                                          1   2
                                                                          2   0
                                                                          3   1
                                                                          4   4
                                                                          5   3
                                                                na            2
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   1
                                                                          2   3
                                                                          3   0
                                                                          4   7
                                                                          5   0
                                                                na            1
Only a few software documents are personally useful to
me.                                                          35 opinion           4
                                                                          1   0
                                                                          2   1
                                                                          3   1
                                                                          4   8
                                                                          5   2
                                                                na            0

                                                                              0
                                                                              0
                                                                              0
                                                                              0
                                                                              0
0

0
0
0
0
0
0

0
0
0
0
0
0

0
0
0
0
0
0
     166   189   212   221   229   235   246   251   10




      3     5      4    3     4     4     5     5




na          3      4    2     1     2     2     2    2




      5     4      4    4     5     4     2     2    4




      5     1      2    4     5     4     4     2    2




      3     1      2    4     4     2     2     2    4




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




na       5   4   2   4   2   4   2   4




     3   4   4   2   2   4   4   2   2




     4   1   2   4   4   2   3   4   1




     5   4   2   2   3   2   3   2   3




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




4   2   2   2   2      4   1      3        3




4   1   4   5   5      4   4      2        4




5   1   1   1   4      3   5      2        2




5   4   2   4   5      4   3 na       na




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




     5      3   2   4   4   5   3   4   na




     5 na       4   4   1   5   1   4   na




na          1   4   2   4   4   4   4        4




     4      5   4   3   4   4   2   4        4
11   23




4    2




1    2




4    4




4    4




4    2




2    2
4   4




4   4




5   4




1   2




2   4




4   4
5   3




5   1




4   2




2   2




4   3




4   3
5   4




2   3




3   4




2   2




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




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




T-Test Data
Req
Spec
DD
LLD
Arch
QA

Req
Spec
DD
LLD
Arch
QA
                Clients                          Jr.       Technical Writer
                              Manager Sr. Developer Developer         N/A
    Requirements          0         80       20          0         0          0
    Specifications        0         60       40          0         0          0
    Detailed Design       0         20       80          0         0          0
    Low Level Design      0         20       60         20         0          0
    Architectural         0         20       80          0         0          0
    Testing / QA          0         80       20          0         0          0




                Clients                       Jr.       Technical Writer
                           Manager Sr. Developer Developer         N/A
    Requirements        40       60         0         0         0             0
    Specifications      20       60         0        20         0             0
    Detailed Design      0       40       20         40         0             0
    Low Level Design 0           20       40         40         0             0
    Architectural        0       40       40         20         0             0
    Testing / QA         0       60         0        40         0             0




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

2                         1           2         1                             2
2                         1           2         4                             2
2                         4           3         4                             2
2                         4           3         4                             3
2                         4           3         2                             3
2                         4           2         2                             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
                                                                                                                     9
                                                                                                                     7
                                                                                                                     5
                                                                                                                     5
                                                                                                                     7
                                                                                                                     5
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
                                                                                                                     1    12
                                                                                                                     3
                                                                                                                     3
                                                                                                                     1
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
                                                                                                                     1
                                                                                                                     0
                                                                                                                     11
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
                                                                                                12
                                                                                                5
                                                                                                7
                                                                                                5
                                                                                                0
                                                                                                1
                                                                                                1
                                                                                                1
                                                                                                0
                                                                                                1
                                                                                                1
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
                                                                                                7
                                                                                                10
                                                                                                5
                                                                                                9
                                                                                                10
                                                                                                2
                                                                                                2
                                                                                                1
                                                                                                0
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
                                                                                                5
                                                                                                0
                                                                                                3
                                                                                                1
                                                                                                1
                                                                                                0
                                                                                                0
                                                                                                0
                                                                                                1
7
3
0
166   189   212   221   229   235   246   251   10




       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       1   1


            1       1   1
1
            1




    1       1       1       1   1
            1
11   23




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
         166            189           212           221                229            235             246           251             10
                                                            High Level     Finite state If I could
                                                            Class or       machines       only have 3,
                                                            Component are very            they would
                                                            diagrams as effective         be: 1. Data
I currently useJustso: The Customer Cards are very important suchto how modules hook together.hoc. When it is done, it when the numberusually maintain
                XP PowerPoint diagrams, for explaining things and other documentation is done ad Pictures are only clear is very usful. If is of things shown
                                                            When           Top level      Detailed
                                                            someone        use case       program
                                                            has to have diagrams are specification
               Voluminous diagrams generated by most frequently created documents, orhieroglyphics. amount Word This is becuase they don't really s
                                                            a long          read as Egyptian program least
Class diagrams and Object models. These are themachine. As easy to usually too            s but have the                  of value.
                                                            Word           Word           We are          We have
                                                            Processors, processors, currently             standard       Visio
                                                            JavaDoc,       design/        using the       templates in Rational
               Text editor or Web browser. Notes JavaDoc a simple indent and number layout. For diagram word Rose because it can make a variety of di
                              Proprietary Reviewing Tools diagramming or Word sometimes.
JavaDoc and any word processor. All our documents have FreeLance modelling
                                            PowerPoint. Adobe Acrobat                     System          various I prefer Visio,
                                                            Word                          Though
                                                            Processors,                   funded for it,
                                                            Visio They     Auto           I chose not
               Automated used them but itcollect the right information. generators. to introduce
                                             was difficult. can be good
Excel and powerpoint. I'vetools. They don't vi                                                                           XML-
                                                                           Real-time      Internal        Database
                                                            Web            embedded       applications and related based
                                                            Solutions, e- systems for supporting          applications email plug-
Finicial Services. We pictureC/C++focusedDatabase applications Movement of /money.
                                                            Commerce defence
               motion are currently Compilers & Class Libraries
                              software R&D on the Settlement and                          the             (products,     in Email
                                                            In the         We typically We would
                                                                                                                         Fairly
                                                            position I am follow a        like (or say
                                                            in now I have modified        we would                       successful
                                                            more           waterfall      like) to follow                . Doesn't
                                            made                                   ie. we anditerative                   make the
                                                                                          an our particular environment. These changes aren't really drastic mu
                                                            freedom to tomodel: it easier forcleanly, then extend to version 1. But, our projects have becomecha
               whole pretty successful with our process, which is to prototype quickly
We follow the We're XP process. We have Fairly some modifications make
                                                                           We have        Reverse
                                                                           had limited engineer the
                                                                           success with database
                                                            JavaDocs,      this. We use design into
               No. We used JavaDoc, own tools for this Visio               Artisan RTS to System No.
                                                             purpose, but ran out of time the the API. We don't have any comments in the code unless it is some
We will sometimes generateto write ourbut this is simply done to help people understand maintain them.
                                                                                          Documentati Functional,
                                                                                          on is           Design, and
                                                                                          important but Test specs
                                                                                          getting         are due for
                                                                                          quality
Our company follows XP for all softwarerequired. That's like a readme, but with at producing only theevery feature that that are especially troublesome the d
                                                                                                           documentation
               An overview document is development. We are very successful more architectual depth. A few modules is needed. I would say most of get th
         11         23


FSM


use cases
XML
editor and
custom
tools
Text/html
editors/W
Pmall
s             ATM
company,      Edge and
provides      Core
solutions     switches




custom
tools


no official
policy.
       14                            15                                            16
count     mean      sd        count     mean      sd                        count
    11.00      2.27      1.01     12.00      3.83                      0.94     12.00

 2.272727     1.00905      2              2              4               1            11
 3.833333    0.937437      4              4              5               2            12
 3.416667    1.311372      4              4              5               1            12
      2.75    1.05529      2            2.5              4               1            12
 3.545455    1.035725      4              4              5               2            11
 3.916667    0.792961      4              4              5               2            12




Q4       Documentation Maintenance
Requirements                 Specs                                            DD
mean     count    sd         mean              count          sd              mean
      3.40        1.34      5           3.00           1.41               5          2.80




Q6       Who Reads What
Requirements                    Specs                                         DD
mean     count    st dev        mean           count          st dev          mean
      3.60        1.67      5           3.20           1.48               5          2.20
                                    17                                           20                                           35
mean           sd            count     mean      sd                       count     mean      sd                       count
        3.42            1.31     12.00      2.75                     1.06     11.00      3.55                     1.04     12.00




                               LL                                           Arch                                         QA
count          sd              mean          count          sd              mean          count          sd              mean
        0.84               5          2.20           1.10               5          2.60           0.89               5          3.40




                               LL                                           Arch                                         Qa
count          st dev          mean          count          st dev          mean          count          st dev          mean
        0.84               5          1.80           0.84               5          2.80           1.48               5          2.40
mean           sd
        3.92            0.79




count          sd
        1.52               5




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

								
To top