Published Date: July 25, 2024
Audience: Everyone
Products and Versions Covered:
- Jama Connect®
Use Case
Model-based vs Document-centric Project Structures
Best Practice
When implementing Jama Connect®, one of the first critical decisions teams must make is how to structure projects. Regardless of industry or company size, two primary approaches are considered:
Model-Based Product Structure
Projects are organized to reflect the logical breakdown of the product, such as systems and subsystems, or aligned with teams and disciplines.Document-Centric Structure
Projects are structured to mirror document-export needs, with the Explorer tree organized in a manner similar to a Table of Contents.
Example Structures
Model-Based Product Structure:
Organized by levels of requirement abstraction and/or engineering disciplines.Document-Centric Structure:
Explorer tree hierarchy represent sections of a document.
| Model-based Product Structure | Document-centric Structure |
|
|
Choosing the Right Structure
Teams that do not require document export often benefit most from a Model‑Based Product Structure. This structure organizes information by requirement type, abstraction level, and team or discipline. This makes navigation, collaboration, and permissions management easier and more efficient.
Teams migrating from tools like Microsoft Word may start with a Document‑Centric Structure to reduce adoption friction. Replicating familiar document layouts can help ease the transition. Over time, many teams naturally shift toward a model‑based approach.
For regulated teams or those required to produce formal documents (e.g., for QMS or compliance audits), a document-centric approach may seem like the only choice. However, hybrid approaches can provide the structure needed for compliance while still delivering the flexibility and efficiency of a model‑based system.
Supporting Documents Within a Model-Based Structure
Before choosing how to structure projects in Jama Connect, teams should clarify the purpose of the documents they need to produce:
-
For handoff or internal review
Teams may have flexibility in format, allowing them to structure Jama Connect around workflows and product definition rather than mirroring a document layout. -
For audits or procedural compliance
Formal document requirements may take priority. Outputs may need to follow specific templates or align with established standard operating procedures.
Even in highly regulated environments, Jama Connect can support both structured, model‑based organization and reliable document generation, allowing teams to export necessary documents without sacrificing usability or efficiency.
The Role of Advanced Filters
Jama Connect’s Advanced Filters allow you to query across your project, regardless of how items are organized, enabling teams to:
Structure projects logically (by team, requirement type, abstraction level, etc.)
Generate documents using filters that pull together the relevant content
Example: Medical Device Framework
For example, the Medical Device framework includes two project structure options:
-
Model-Based Product Structure
Organized by abstraction level, following a Systems Engineering V-Model
Functional and discipline-based item grouping
Documentation is handled through Advanced Filters
Filters include shared elements (e.g., Project Overview) for consistency
-
Document-Centric Structure
Simulates a Design History File (DHF)
Includes contextual elements like Introduction, Scope & Objective, and References
Designed to support document creation, review, and export for submission to a QMS
Works seamlessly with configured report templates to meet organizational documentation requirements
Flexibility for Evolving Needs
Different teams within a single Jama Connect instance may require different project structures. Jama Connect supports different template needs.
Initial project decisions don’t have to be permanent. Over time, teams can:
Restructure projects to reflect updated practices
Shift from document-centric to model-based (or vice versa)
Improve how content is grouped, reviewed, and exported
Adjust project templates to implement new and improved procedures for new projects
Additional Resources
Need help determining the best structure for your Jama Connect projects or looking to optimize your configuration?
Explore our Solutions Offerings*:
*Note: Requires enrollment in the Solutions Success Program. Please contact your Jama Software Customer Success Manager for details.
Feedback:
We welcome your input! Please sign in to leave any comments, suggestions, or ideas for improvement below.
Comments
0 comments
Please sign in to leave a comment.