Introduction: Why Documentation Matters in RISA for Regulatory Approvals

Accurate and thorough documentation of structural analysis in RISA is the cornerstone of obtaining regulatory approvals. Whether you are designing a multi-story steel frame, a concrete shear wall, or a complex truss system, the reports you generate directly influence how quickly and confidently building officials approve your work. Poor documentation—missing load cases, vague assumptions, or incomplete output—triggers review cycles that can delay project timelines by weeks. This article distills best practices for producing regulatory-grade documentation using RISA, covering everything from input data management to version control and code compliance.

A well-prepared documentation package does more than satisfy a checklist. It provides a transparent narrative of the structural behavior, clarifies design choices, and demonstrates that the analysis aligns with local building codes such as the IBC, ASCE 7, and AISC 360. By integrating the strategies outlined below, engineers can reduce rejection rates, streamline peer reviews, and build confidence with approving agencies.

Importance of Proper Documentation in RISA

Regulatory bodies require comprehensive reports that clearly outline the assumptions, calculations, and results of structural analyses. Without proper documentation, even the most rigorous analysis may be questioned or rejected outright. The following points underscore why documentation deserves dedicated attention:

  • Transparency and Traceability: Every load combination, support condition, and section property must be traceable. A well-documented RISA model allows an independent reviewer to verify any intermediate step.
  • Demonstrating Code Compliance: Building codes mandate specific design criteria (deflection limits, strength checks, drift ratios). Your documentation must explicitly show how each criterion is met.
  • Risk Mitigation: In the event of structural issues or litigation, a comprehensive documentation trail protects the engineer of record by proving due diligence.
  • Efficiency in Reviews: Organized reports with clear visual aids and explanatory notes reduce back-and-forth with plan reviewers, cutting approval times by up to 40%.

These benefits directly translate to project cost savings and professional credibility. Engineers who treat documentation as a continuum from model setup to final submittal consistently experience fewer RFIs and faster permit issuance.

Best Practices for Documenting Structural Analysis in RISA

1. Standardize Naming Conventions and Units

Begin by establishing a consistent scheme for naming nodes, members, load cases, and sections. Avoid generic labels like “Beam1” or “Load3”; instead use descriptive names such as “Roof_Beam_01” or “DL_Snow_Balanced”. This practice makes the model self-documenting and simplifies cross-referencing within reports. Similarly, set units globally (e.g., kip-ft for US customary, kN-m for metric) and verify they remain consistent throughout the analysis. RISA’s unit settings can be locked to prevent accidental changes.

2. Document All Input Data Thoroughly

A reviewer must be able to reconstruct your analysis from the input alone. Include the following in your documentation:

  • Load Cases and Combinations: List each load case (dead, live, wind, seismic, snow) with its magnitude, distribution, and applicable code reference (e.g., ASCE 7-16, Table 4.3-1). For combinations, show the governing load factors and any exceptions.
  • Boundary Conditions: Provide a clear table of supports and releases, noting pinned, fixed, or spring properties. For base plates or foundation ties, include stiffness assumptions.
  • Material Properties: Record steel grade (A992, A36), concrete strength (f’c), rebar yield (fy), and any temperature or fatigue parameters if needed.
  • Section Properties and Member Sizes: Include the database or custom sections used. If a custom shape was created, document its dimensions and calculation basis.

Use RISA’s “Input Summary” report or export a CSV of the model data. A good practice is to append a “Data Dictionary” page that defines every parameter used.

3. Provide Detailed Output Results

Raw output from RISA can be overwhelming. Focus on the most relevant results for regulatory review:

  • Member Forces and Envelopes: Show maximum positive and negative moments, shears, and axial forces for each critical member. Highlight the governing load combination.
  • Deflections and Drift: Report both immediate and long-term deflections for beams and slabs. For lateral drift, compare results against code limits (e.g., IBC Table 1604.3).
  • Stress Checks (Unity Ratios): Export the “Code Check” summary for steel members or “Design Summary” for concrete. Identify members where unity ratio exceeds 0.9 and justify.
  • Reactions: Provide support reactions for foundation design, including maximum uplift and overturning moments.

Use RISA’s “Report Generation” tool to assemble these outputs into a single PDF. Customize the report to include only the pages relevant to the review—adding too much extraneous data can obscure key findings.

4. Incorporate Visual Aids for Clarity

Diagrams speak louder than tables. RISA’s visual capabilities can be leveraged to produce:

  • Moment and Shear Diagrams: Annotate the critical values directly on the diagram.
  • Deflected Shapes: Scale deformations for visibility and label key deflection values.
  • Load Distribution Diagrams: For seismic or wind loads, show how forces are distributed vertically and horizontally.
  • 3D Model Views: Use isometric views with color-coded member utilization or stress levels.

Export these graphics as high-resolution images (PNG, TIFF) and embed them in the body of the report. Avoid relying solely on text or tables to convey complex load paths. A single annotated diagram can replace paragraphs of explanation.

5. Document Assumptions and Methodologies

Every analysis rests on assumptions—intentional or otherwise. Explicitly state:

  • Analysis type: Elastic linear, P-delta, second-order, buckling, or dynamic (response spectrum, time history).
  • Modeling simplifications: Rigid diaphragms, semi-rigid connections, or member releases assumed.
  • Loading simplifications: Uniform distributed loads, concentrated loads, or reduced live loads per code allowances.
  • Code and version used: IBC 2021, ASCE 7-22, AISC 360-22, ACI 318-19, and any jurisdictional amendments.
  • Software version and verification: RISA-3D v21.0.1, including any necessary verification against hand calculations or known benchmarks.

This section should read like a methodology statement in a peer-reviewed paper. It demonstrates professional rigor and allows reviewers to assess whether the assumptions are appropriate for the specific project.

6. Use Version Control Explicitly

Structural models evolve during design. Save and name each version with a meaningful tag (e.g., “Model_v2.3_revB_steel_upgrade”). Within the documentation, include a version history table that notes changes, dates, and who made them. RISA does not have built-in version control, but you can implement a system using file naming, a shared folder with history, or a dedicated version control tool like Git LFS for binary files. Every submittal package should reference the specific model version used to produce the results.

Leveraging RISA’s Built-In Documentation Tools

RISA offers several features that directly support regulatory documentation. Knowing how to maximize these can save hours of manual report writing.

Report Generation

The Report Generator in RISA-3D and RISAFloor allows you to create comprehensive documents covering input data, results, and design checks. Key settings to configure:

  • Include only the needed tabs (Input, Envelopes, Code Check, Reactions).
  • Set the page format to landscape for wide tables.
  • Add a title page with project name, job number, engineer name, and date.
  • Insert explanatory text blocks within the report (available in newer versions).

Generate report PDFs directly from RISA to avoid formatting errors during export.

Export Options

For integration with broader documentation, export data to:

  • Excel: Export tables of member forces, deflections, and reactions. Use Excel to create custom summary tables or charts for the report.
  • DXF/SVG: Export model geometry and diagram overlays for use in CAD or drafting software.
  • Image files: Export screen captures of 3D views, load distribution, and deflected shapes.

Always re-import exported data into the report draft to verify consistency. An Excel table that doesn’t match the RISA output undermines credibility.

Annotation and Notes

RISA allows you to add notes directly to the model. Use these to document assumptions in-context—for example, a note on a specific member explaining why a larger section was chosen, or why a release was applied. These notes can be exported as part of the report or used as a reference when writing the final documentation narrative.

Common Documentation Pitfalls and How to Avoid Them

Even experienced engineers make mistakes that delay approvals. The following pitfalls are frequently encountered:

  • Inconsistent units: Switching between kips and pounds mid-model. Solution: Lock units before beginning, and always run a unit consistency check.
  • Missing load combinations: Failing to include ASD or LRFD combinations as per code. Solution: Use RISA’s automatic combination generation based on the selected code.
  • Unverified code checks: Relying solely on RISA’s default code checks without verifying member slenderness, local buckling, or special seismic provisions. Solution: Cross-check a sample of members manually or with an independent spreadsheet.
  • Incomplete version history: Submitting a report without documenting which model version produced it. Solution: Always append the file name and date to the report title page.
  • Overreliance on automatic reports: Assuming the default RISA report is adequate. Solution: Customize the report to highlight key findings, and add a narrative section to explain the analysis logic.

Conduct a final peer review of the documentation package using a checklist that mirrors the regulatory submittal requirements. Have a colleague run through the model inputs and outputs to catch discrepancies.

Documenting Code Compliance: A Focus on IBC, ASCE 7, and AISC 360

Regulatory approvals hinge on demonstrating that the analysis respects the governing building code. Your documentation must explicitly tie each RISA output to code clauses. For example:

  • Drift limits: Report the maximum story drift from your RISA model and compare it to the allowable drift per IBC Table 1604.3 (e.g., 0.025h for seismic). Provide the calculation: drift = (Δmax / story height).
  • Strength design: For steel members, show the unity ratio from AISC 360-16 Chapter F (flexure) and Chapter G (shear). Highlight any members that approach the limit, and justify with a note that the check includes Phi factors per LRFD.
  • Seismic load effects: Document the base shear computed using ASCE 7-16 Equation 12.8-1 and the applied distribution method (equivalent lateral force vs. modal analysis). Include RISA-generated story shears and compare to code minimums.

Create a separate section in your report titled “Compliance Matrix” where you list each code requirement, the corresponding RISA check, and the result (Pass/Fail). This matrix gives reviewers a quick road map to verify compliance without hunting through dozens of pages.

Peer Review and Quality Assurance

A thorough internal quality assurance process before submission can catch errors that lead to rejections. Consider the following steps:

  • Independent model check: Have a second engineer recreate a critical portion of the model (e.g., a couple of frames) and compare results. Document any differences and resolve them.
  • Check of load paths: Trace a representative load from the roof to the foundation, verifying that reactions and forces are consistent.
  • Review of boundary conditions: Confirm that all supports are properly modeled and that no unintended fixities exist.
  • Documentation consistency: Ensure that the verbal description in the narrative matches the RISA output. For example, if you say “wind load is based on ASCE 7-22,” the load combinations should reflect that version.

Incorporate a QA checklist in your firm’s standard procedures. A good reference is the Structural Engineering Institute’s quality management guidelines.

Using Digital Documentation and Cloud Collaboration

Modern practice increasingly involves cloud-based file sharing and digital submittals. To streamline regulatory approvals in this environment:

  • Generate searchable PDFs: When exporting reports, enable the searchable text option (not scanned images). This allows reviewers to quickly find specific load cases or member groups.
  • Organize files with a consistent folder structure: For each project, maintain folders for “Models”, “Reports”, “Review Comments”, and “Final Submittal”. Use version numbers in file names.
  • Leverage hyperlinks in PDFs: Some engineers embed hyperlinks in the table of contents that jump to specific sections or to the relevant RISA output page.
  • Track changes with a comment log: When responding to reviewer comments, maintain a log that cross-references each comment to the corrective action and model version.

Cloud platforms like Bluebeam, SharePoint, or Aconex allow real-time collaboration. Use these to circulate the RISA model and documentation to the full team, ensuring that everyone works from the same version.

Final Tips for a Successful Regulatory Submittal

Adopt these final practices to push your documentation from good to exceptional:

  • Start early: Begin documenting assumptions and methodology as you set up the model, not after analysis is complete. This prevents omissions.
  • Engage with local building officials early: Understand their specific documentation requirements. Some jurisdictions require a stamped copy of the RISA input file or a signed statement of software verification.
  • Keep a “Documentation Library”: Develop templates for common analysis types (steel moment frame, braced frame, concrete flat slab) that already include standard code references and report formats. Customize these per project.
  • Update your practices with each RISA release: New versions may introduce better reporting features or updated code checks. Review the release notes and incorporate improvements into your workflow.
  • Include a narrative summary: Write a short executive summary that explains the overall structural behavior, the governing load cases, and any critical design decisions. This helps non-engineering reviewers (e.g., plan checkers with a general background) grasp the key points.

By embedding these principles into your daily workflow, documenting structural analysis in RISA becomes a seamless part of the design process rather than a last-minute scramble. The result is a submittal that communicates your engineering judgment with clarity, builds trust with regulators, and minimizes costly delays. For further reading, consult the RISA documentation guides and the AISC education resources on effective design communication.