Skip to content

Terminology and numeric consistency validation #18

Description

@jd-garv

Validate terminology and numeric consistency across BioSpec documents.

Problem:
Users may be inconsistent between fields or documents (e.g., "T cells" vs "T-cells" vs "T lymphocytes", or sample counts that don't match across specs).

Validation checks:

Terminology consistency:

  • Detect variations of the same term across documents
  • Flag inconsistent capitalization or spelling
  • Suggest standardized terminology
  • Maintain project-specific glossary

Numeric consistency:

  • Sample counts match between intent.md and datasets.md
  • Resource estimates align with data volumes
  • Timeline milestones don't conflict
  • Budget/resource numbers consistent across sections

Examples of issues to catch:

❌ intent.md: "50 melanoma samples"
   datasets.md: "62 melanoma tumor samples"
   → Mismatch: 50 vs 62

❌ project_overview.md: "T cells"
   intent.md: "T-cells"
   relationships.md: "T lymphocytes"
   → Inconsistent terminology for same concept

❌ project_resources.md: "Expected duration: 3 months"
   intent.md: Milestones span 6 months
   → Timeline inconsistency

Implementation:

  • Run as validation command or pre-commit check
  • Report inconsistencies with suggestions
  • Allow user to define synonyms/acceptable variations

Benefit: Improves spec quality and reduces confusion for collaborators

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions