Project Description and Plan – OSD700
In this post I will be outlining the the goals set for the seven (7) releases (0.4 – 1.0) required by OSD700. This is a continuation of the project I worked on in OSD600, Document Mozilla External String Guide. (Wiki link)
Previous Links:
Here is the Initial Project plan for 0.1 – 0.3 of this project
Here is the 0.3 (last) release post for the project
Major Work:
A major bug to be corrected is 530175 “type-printer.js error with function pointer parameter.”
While the main work to be done on the project is the exploration and documentation of functions and techniques related to External Strings which have not yet been completed. These functions and techniques are already laid out in the Documentation (MDC page) Mozilla External String Guide.
Minor Work:
Most of the minor work to be done on the project is clean up. Clean up will include creating and standardization a suitable layout, as well as proof reading for both grammatical and technical errors .
Once the currently laid out documentation is filled out and in a favorable format it may be necessary to find out what other functions and techniques will benefit the documentation with their addition. This task may be upgraded to major because of the weight of choices. External Strings just like Internal Strings cover a very broad, branching number of fields and the process of choosing which pieces of information will be included and which won’t could be time consuming.
Version Objectives:
0.4: While conversing with the community about solutions to the Function Pointer Parameter Bug (Bug: 530175), a majority of missing information in the documentation will have been added.
0.5: The Function Pointer Parameter Bug corrected and Static Analysis information refreshed.
0.6: I suspect that one or both of the above releases will have an overflow which will be brought over to a later release.
0.7: With the added content the layout will be modified, tested, and standardized.
0.8: Any additional information which should be covered in the documentation, but isn’t, will be collected and listed. I am thinking I might post to a mailing list asking others what should be added. This release will include a list of the new additions after being collected, researched, and refined.
0.9: The missing information found in the previous release will be thoroughly researched and populated. Since the information from early releases (0.1 – 0.3) has been used to create a nice layout this information should be entered using that layout and not require reformatting.
1.0: In preparation for this release the documentation will be looked over with a fine-toothed comb and polished. This includes making sure the layout is consistent and clean, making sure spelling, grammar, and references used internally with Mozilla (function name, macros, ect.) are correct. Only after these things have been checked will the technical data be reviewed again. This is because most of it has been checked once already, there is reason to believe the information was entered correctly the first time (don’t strike me down,) and the process is time consuming.
