Status field and project statistics view

[aa956]

Trying to use strictdoc (instead of Excel) for one of the new projects I have to track requirements for.

Status field looks to have some hardcoded selections in project statistics report.

• Active
• Draft
• Backlog

Is it a good idea to implement these into the grammar? Something like this:

- TAG: REQUIREMENT
  FIELDS:
  - TITLE: STATUS
    TYPE: SingleChoice(Draft, Active, Backlog)
    REQUIRED: False

And select these values in the statistics report here instead of hardcoded values?

This will allow us to simply add new states, like if we want to distinguish requirement withdrawn by customer vs rejected by us (document the not necessary state vs impossible to implement state vs not applicable to the current project/device/environment):

- TAG: REQUIREMENT
  FIELDS:
  - TITLE: STATUS
    TYPE: SingleChoice(Draft, Approved, Withdrawn, Rejected, NotApplicable, Implemented)
    REQUIRED: False

[aa956]

E.g. "Verified" or "Tested" states can be added in this way too.

[stanislaw]

This is one of the immediate backlog items: how to make the project statistics screen not be hardcoded to the exiting statistics and queries behind them.

Right now it is not clear to us how to expose a configurable interface or a user to completely customize the statistics table, i.e., add more statistics, remove the existing, possibly change the layout, etc. Should this be a custom Python/HTML/Jinja or a mix of them that a user has to write to replace the default statistics function 🤔 🤔 🤔 🤔 🤔 ...

If you want to contribute to this discussion, feel free to join the office hours: https://strictdoc.readthedocs.io/en/latest/latest/docs/strictdoc_01_user_guide.html#SDOC_UG_CONTACT.

(The next office hours is tomorrow 29.04.2025 at 1700 CEST.)

[aa956]

feel free to join the office hours

I'll be away then and my knowledge of proper patterns of Python programming is limited.

Custom Python will be probably simplest to implement?

Just with some way to avoid editing strictdoc code itself. Simple plugin?

E.g. setting in strictdoc.toml that points to the python file that should contain ProgressStatisticsGenerator class with the same signature as existing one or subclass of it?

Then something like https://docs.python.org/3/library/importlib.html#importing-a-source-file-directly

Also setting pointing to jinja template that may be used instead of html/templates/screens/project_statistics/main.jinja.

[stanislaw]

Your thoughts are exactly in the direction I was thinking of but I need some time to decide on the best way to move forward.

Just in case: The office hours are joined by all sorts of people, the Python programming knowledge is not required.

[stanislaw]

Closed with this PR: #2207 (comment).