meindertn / roboclerk Goto Github PK

Right now test steps are in a string array. They should be in a dedicated object.

A dll dependency problem is causing the GIT support to fail. This is a known problem for the git library RoboClerk uses.

The software solution currently does not have a good method for creating a distributable package. Ideally it should be possible to publish the software for both Windows and Linux from the same solution.

This makes the output look bad because the \ characters are still present.

If no commands are provided for a document a null pointer exception occurs

Right now the redmine plugin assumes the items have been dumped to CSV, instead the plugin could use the redmine API directly (or probably support both).

All tables use the indicator "requirement ID:". This should be changed depending on the entity that is being written and the name of that entity

Roboclerk should be able to serialize its data structures to enable it to save its state at a release. Minor fixes after release would then use the serialized data instead of the live data. It should support pulling in specified new items as well as ignoring certain items from its serialized data.

an index out of bounds exception is generated when an inline roboclerk tag is at the end of a file without newlines or spaces.

There should be a standardized way of referencing all documents RoboClerk knows about (the ones that it is generating). In addition to that there should be a way to make RoboClerk aware of documents that it is not generating and reference those. This will be helpful when certain standards are referenced in multiple places or certain documents are referenced in multiple places. Then one only has to update references in one place.

This creates the ability of re-using particular sections of documents across a whole set of documents.

It should be possible to include comments in the templates to help people fill them out. The comments should not show up in the processed documents.

When running git on files you don't own the following error is generated:

Git command output "fatal: detected dubious ownership in repository at '/mnt/
To add an exception for this directory, call:

git config --global --add safe.directory /mnt/<projectdir>

The azure devops plugin right now assumes certain types of work items are used to represent certain trace entities. While certain pieces of information need to be present in the workitems, the type of workitem should at least be customizable.

Allowing users to group images in directories would be a good feature to have.

RoboClerk should be able to collect information about unit tests from the source code files defining the tests. This information could then be used to generate a unit test plan.

Test coverage is very low, need to improve it.

When a called executable fails, the failed executable is indicated but the output from the executable is not included in the error message. This would facilitate troubleshooting.

RoboClerk should verify that each planned automated test has passed instead of relying on reviewers to verify the evidence.

When a test case is placed in the system test plan, but it has no parent requirement, this is not picked up by the trace analysis.

Right now just the number of the truth item which is the source of the trace matrix gets displayed when a link in a trace document is present. This causes confusion for users. Instead it should say "Present" or "MISSING"

RoboClerk should support referencing internal properties of the document like its title, its abbreviation and its identifier

Rejected items linked to active items could still show up in the trace analysis

In various formats, post processing is needed to create the documentation in a way that matches required look and feel of the documentation in HTML or DOCX. We should support tags that are focused on that. For example:

• remove line
• insert TOC
• insert page break

Right now, document references only support showing the title and the abbreviation. We should make the identifier and template file also available.

pull apart project specific and general files

By using roboclerk tags that have other roboclerk tags in them, more dynamic document content can be created.

Provide a way to visualize the FMEA in the risk assessment process documentation.

Right now the versions are updated to the latest every time the container is built, this causes a variety of issues because the libraries are changing and are breaking existing publishing scripts.

When text fields are placed in tables, pipe characters present in the field are currently not escaped which can lead to messed up tables.

One element of the software where additional flexibility would be good is allowing users to change the way adoc elements (e.g. a software requirement) are generated. Right now, this is compiled into the software and this makes changing RoboClerk to adapt to different use cases onerous. The proposal is to use Roslyn to allow users to change the way elements are created. A standard set of scripting functions should be developed so that users will have a basic toolkit at their disposal.

The test case system should support multiple when then statements.

Given: state

When: action
Then: expected result
action
expected result

Need to update what exists and create new documentation for the software

For example, a test that does not have a condition to verify or a requirement without a description etc. These could be reported as warnings in the log file or in a separate report.

All items should support a status flag

Lists with sub items indentation is not correct, they are all aligned the same way. This is due to a bug in the way the post-processing scripts handle indentation for headings.