Community
Participate
Working Groups
RMF should contain the requirements on RMF as example ReqIF files. This has the following benefits: * users get a set of reqif files that illustrate the features of RMF * rmf developers have a defined location for adding or modifying requirements on RMF * by using ProR for documenting requirements we use our own implementation and find potential bugs earlier
Mark, Lukas already started something like this (maybe not in the best location) in a folder/project called "dump". The contained .reqif files are picked up by Hudson and upon change, HTML will be generated automatically, see https://hudson.eclipse.org/hudson/job/rmf-nightly/lastSuccessfulBuild/artifact/dump/html/ Providing useful (and non-stale) content is obviously another question. We should work on straightening the documentation. Does this resolve/address your idea? If not, please reopen.
I was looking for a solution that makes the requirements on RMF available as an example that can be created in the workspace by using a NewExample wizard. (1) For that reason I analyzed how the EMF project creates the its example wizards. The result is now available in GIT: The following projects have been added: - org.eclipse.rmf.docs.requirements This project will contain the requirements in RMF. I already added an initial set. Still far from complete but it already turned out to beneficial to have the requirements written down somewhere - org.eclipse.rmf.docs.tests This project is going to contain some test specifications. Currently only empty reqif files are available - org.eclipse.rmf.examples.installer This is the plugin that provides the end user wizard for installing the examples into the workspace. The plugin XML contains references to the projects that should become part of the examples. any modification of the example projects are automatically populated into the /examples/ subfolder by means of build extensions. - org.eclipse.rmf.releng.examples This project contains some some scripts that are required for automatically copying the content of the example projects into examples folder of the installer project.
I think we can make the reqif files that are now contained in the dump folder available in examples as well. Maybe we con put them into the org.eclipse.rmf.docs.requirements project. The Eclipse IDE will then propagate the content into the examples.installer plugin. Additionally hudson could render html representations of the reqif files in the examples.installer plugin which can then become part of the example that is installable using the RMF Examples installation wizard. I think what is left open before the next snapshot release: we need to check the content of the example requirements and decide if they have a sufficient quality. Regarding the initial set of RMF requirements I definitely think that they need some improvement ;-)
Mark, This is definitely a much better solution than the dump folder, which should be abandoned in favor of better named ones (like suggested here). I wonder whether the structure isn't overly complicated. Specifically, wouldn't it be better to have "official" .reqif files only in one single plugin, optionally with a subfolder structure? I like org.eclipse.rmf.docs.requirements, but I don't see a need for org.eclipse.rmf.docs.tests. Also, there are many .reqif files right now that are currently just stubs. This is fine if we can manage their content, but I am worried that we don't have the resources for it. Therefore, rather than having stub files (like RMF_SoftwareUnitTestSpecification.reqif), I would prefer not to have such a file at all. I would suggest to keep the number of .reqif files to a minimum, but to make sure that those we have are in really good shape. Next steps: Please continue to refactor as you see fit. Once you're done, we should assign this bug to Lukas, to enable the html-generation on Hudson.
