a lot of artifacts
these are the results of the last two days:
- refine the gantt-chart
- project plan:
- project responsibilities defined
- milestone artifacts, function-id added in the implementation phases
- system requirements specification:
- function description extended
- GUI specification added
- start with the external design
- first draft of the domain model
here are some impressions from the external design, the full external design can you find on the svn-server in the design folder.
this screenshot shows the first page, when you enter
the sharecodedoc site
the sharecodedoc site
the next one shows you a documentation page from a project.
the fields, which are marked with a red rectangle can be edited.
the fields, which are marked with a red rectangle can be edited.
the comments from the previous screen will be filled in the textboxes. the user can edit the comment now. domain model
gantt-chart
the revision of the gantt-chart, has changed the artifacts for next mondaysmeeting, because the srs takes more time then i expected. but i think it should be possible, that i can start with the implementation next week.
srs
i've identified the following use-cases:
architecture
i think the best choice is, that we make a 2-tier architecture. the first tier contains all the presentation things and the second tier contains the core, which have the problem domain with documentation generation, read the documentation out of the source files and sync back the documentation into sourcefile. what are your thinkings about it?
if you have time, please give me a little comment specially for the srs and the use-cases. so that i can finish the srs tomorrow and start with the design process.
gantt-chart
the revision of the gantt-chart, has changed the artifacts for next mondaysmeeting, because the srs takes more time then i expected. but i think it should be possible, that i can start with the implementation next week.
srs
i've identified the following use-cases:
- edit comment (Kommentar editieren)
- navigate throug documentation (Navigation)
- save documentation (Kommentar speichern)
- setup sharedcodedoc project (Projekt erstellen) -> new actor identified: server administrator
architecture
i think the best choice is, that we make a 2-tier architecture. the first tier contains all the presentation things and the second tier contains the core, which have the problem domain with documentation generation, read the documentation out of the source files and sync back the documentation into sourcefile. what are your thinkings about it?
if you have time, please give me a little comment specially for the srs and the use-cases. so that i can finish the srs tomorrow and start with the design process.
posted by Remy Blaettler @ 5:30 PM
2 comments
2 Comments:
Pascal,
Nice progress. Here my feedback.
SRS:
----
1) I couldn't find the additional use case descriptions neither the exceptions in the latest SRS. I guess you are still working on this? Don't forget to describe the entire process as a sequence of all the use-cases. Writing source code, generating NDoc, importing into SharedDocServer, modify docu online, sync back into the source.
2) In the SRS Appendix (Anhang) you put an NDoc screenshot of just one method. Try to put a full class with all possible elements.
3) Also add events, delegates and interfaces as elements which are documentable.
Domain-Model:
-------------
1) A project contains other projects. Shouldn't it be a solution contains several projects?
2) Events and delegates can be defined outside of a class context. What about interfaces?
Architecture:
-------------
1) It seems you think of generating the docu webpage with each request? I don't think that's possible due to performance problem. NDoc should generate a baseline documentation which will be modified and at a certain point in time synced back. Or am I wrong here?
2) For now 2-tier is ok but will turn into 3-tier. Web server, source control should run on different machines.
Keep up the good work.
Reto
in general, agree with Reto's comments.
Here my additions:
conflict resolution
-------------------
One thing that has gone completely missing so far is a conflict resolution. What happens if someone changes the documentation in the code and someone else changes it at the same time in the online docu?
That was the easy case, the complicated case is, if a refactoring happens, then we pretty much loose all associated online comments.
Would not put the second case as a requirement for phase 1, but I would at least mention and discuss it. First case should be included.
Use Cases
---------
Could not find new use cases either?
Domain Model
------------
Solution can contain multiple projects. Would stick with that.
Architecture
------------
Go with 3-tier, just for the sake of it. 90$ of all apps are 3 tier.
Real-time sync would be cool, but might be a challenge.
GUI
---
Looks good to me. Is my understanding correct that there is one edit button per page and then you can edit all comments on the same page? Pics in SRS and in the Blog look different.
Blog
----
I like how you use the blog, helps us to get the core infos quickly and easy.
Post a Comment
<< Home