SwiftReporter

Creating and Managing Comments

Creating and Managing Comments

SwiftReporter creating comments

Comments are the foundation of an efficient inspection workflow. This guide explains how to create, organize, and manage your personal comment library to maximize consistency and efficiency across all your inspections.

Understanding Comment Types

Defect Comments

Defect comments identify issues that require action or attention. They are comprehensive observations that include:

Required Fields:

  • Title: Brief, descriptive name for the defect
  • Description: Detailed explanation of the issue
  • Recommendation: Specific action needed to address the defect
  • Template: Which inspection template this applies to
  • Category: Main inspection area (e.g., "Electrical System")
  • Subcategory: Specific component (e.g., "Main Panel")

Optional Fields:

  • Severity: Priority level (Monitor/Maintenance, Recommendations/Improvement, Material Defects/Safety)
  • Location: Specific location where defect was found

Example Defect Comment:

Title: GFCI Outlet Not Working
Description: GFCI outlet in kitchen does not reset when tested. Pressing test button does not trip the outlet, and reset button has no effect.
Recommendation: Replace GFCI outlet and verify proper wiring connections. Test all downstream outlets to ensure proper GFCI protection.
Severity: Material Defects/Safety
Location: Kitchen counter near sink

Note Comments

Note comments provide informational content for reports without requiring action. They include:

Required Fields:

  • Title: Brief, descriptive name for the note
  • Description: Complete informational content
  • Template: Which inspection template this applies to
  • Category: Main inspection area
  • Subcategory: Specific component

Example Note Comment:

Title: Inspection Limitations - Weather Conditions
Description: Inspection performed during light rain. Roof access was limited due to wet conditions. Recommend follow-up inspection of roof surface during dry weather conditions.

Creating Comments

From the Comments Library

  1. Navigate to Comments: Go to the Comments section in your app
  2. Add New Comment: Tap the "+" or "Add Comment" button
  3. Select Comment Type: Choose "Defect" or "Note"
  4. Fill in Required Information:
    • Enter a clear, descriptive title
    • Write comprehensive description
    • For defects: Include specific recommendation
    • Select template, category, and subcategory
  5. Add Optional Details: Include severity and location if applicable
  6. Save Comment: The comment is automatically added to your library

From Observations

When you create a detailed observation during an inspection, you can save it to your comment library:

  1. Complete Observation: Fill in all observation details
  2. Save to Library: Use the "Save to Comment Library" option
  3. Review Content: The system pre-fills the comment with observation data
  4. Edit if Needed: Modify any fields to make the comment more reusable
  5. Save to Library: The comment is added to your personal library

💡 Tip: Creating comments from real observations ensures they're based on actual field experience and are immediately useful.

Organizing Your Comment Library

Template Association

Comments should be organized by template for maximum relevance:

Best Practices:

  • Create template-specific comments for unique requirements
  • Use general comments for issues common across templates
  • Keep template associations up-to-date
  • Consider creating master templates for common issues

Category and Subcategory Structure

Follow your template's category structure:

Example Structure:

Template: Residential Inspection
├── Electrical System
│   ├── Main Panel
│   ├── GFCI Outlets
│   └── Lighting Fixtures
├── Plumbing System
│   ├── Water Heater
│   ├── Fixtures
│   └── Supply Lines
└── HVAC System
    ├── Heating Equipment
    ├── Ductwork
    └── Ventilation

Naming Conventions

Use consistent naming patterns for easy searching:

Good Naming Examples:

  • "GFCI Outlet Not Working"
  • "Water Heater Temperature Relief Valve Missing"
  • "Electrical Panel Overcrowded"
  • "Inspection Limitations - Weather"

Avoid:

  • Generic names like "Electrical Issue"
  • Abbreviations that aren't universally understood
  • Location-specific names for reusable content
  • Overly technical jargon

Managing Existing Comments

Editing Comments

  1. Find the Comment: Use search or browse by category
  2. Select Edit: Choose the edit option for the comment
  3. Update Content: Modify any fields as needed
  4. Save Changes: Updates apply to future usage

🚨 Warning: Editing a comment doesn't change past observations or reports where it was used. Changes only apply to future applications.

Deleting Comments

  1. Locate Comment: Find the comment you want to remove
  2. Delete Option: Select the delete action
  3. Confirm Deletion: Confirm you want to permanently remove the comment
  4. Library Update: The comment is removed from your library

⚠️ Note: Deleted comments cannot be recovered. Consider editing instead if the comment has value.

Usage Tracking

The system automatically tracks:

  • Usage Count: How many times you've used each comment
  • Last Used: When the comment was last applied
  • Most Popular: Your most frequently used comments
  • Unused Items: Comments that haven't been used recently

Use this data to:

  • Identify your most valuable comments
  • Find unused comments to review or remove
  • Optimize your library organization
  • Understand your inspection patterns

Best Practices for Comment Creation

Content Quality

  1. Be Specific: Include detailed descriptions that clearly explain the issue
  2. Use Professional Language: Maintain a professional tone throughout
  3. Include Context: Provide enough detail for someone else to understand
  4. Action-Oriented: For defects, include clear, actionable recommendations

Consistency

  1. Standardized Format: Use consistent structure across similar comments
  2. Uniform Terminology: Use the same terms for similar concepts
  3. Professional Tone: Maintain consistent voice and style
  4. Complete Information: Include all necessary details

Reusability

  1. Generic Language: Avoid location-specific details in the main content
  2. Flexible Descriptions: Write content that applies to various situations
  3. Template Agnostic: Create comments that work across similar templates
  4. Scalable Content: Design comments that can be easily modified

Advanced Management Features

Bulk Import (CSV or Excel)

Open the bulk import wizard from the comments library or directly from a template page. The wizard runs in this order:

  1. Pick destination template — Choose which template the imported comments should belong to.
  2. Upload file — Drop in a CSV or Excel file. A downloadable sample file is offered on this step. The column-mapping table on this screen scrolls fully so all rows and actions stay reachable.
  3. Map columns — Match your spreadsheet columns to the comment fields. Required per row: type (defect or note), title, description, category, and subcategory. Optional: recommendation, severity (low, medium, or high), location, and Hide title (for note rows only — map a column if your file includes one, or use the checkbox below to hide titles for every imported note on this run). Defect rows must include a recommendation. The Hide title in report for all imported notes checkbox applies only to notes; defects never get this flag from import.
  4. AI summary of issues — If validation finds problems, a high-level summary appears next, listing each problem group (for example, "8 rows are missing recommendations" or "4 unique category names don't exist in the template") with severity and a recommended action. Two primary actions:
    • Edit File & Re-upload — Clears the upload and returns you to the file picker so you can fix the source spreadsheet.
    • Continue — Loads the next step. The button shows a loading state while the next step is being prepared.
  5. Fix issues — A per-row queue walks you through each fixable problem one at a time (missing required values, invalid type, missing defect recommendation). Each error message identifies the column, the data type expected, and the row location, with a remaining-issue counter so you can see progress.
  6. Match categories and subcategories — Unmatched (category, subcategory) pairs are de-duplicated, so you only resolve each unique pair once. The header reads in the form "Mismatch 2 of 5 (applies to 7 rows)" so you can see how many rows your decision will cover. If the AI cannot suggest a match, the import does not fail — you get searchable Category and Subcategory pickers limited to valid template values and pick a mapping yourself.
  7. Commit and review — The wizard creates the rows, skips duplicates against the destination template and against earlier rows in the same import, and shows a final review with counts of created, skipped duplicates, and any failed rows.

Where bulk import works:

  • Solo users (no organization) can import just like organization users.
  • Locked templates (such as TREC or other regulated templates) accept bulk imports too — start the wizard from the template page.
  • All categories and subcategories are valid targets, including categories where the template author has temporarily turned observations off. Notes and defects can still be imported into those categories — they will be available again as soon as the author turns observations back on for that category. You do not need to re-enable observations before importing.

ℹ️ Note: Single-comment editing in the comment library and inline observation creation during an inspection follow the original rules — those are unchanged. The "all categories accepted" behavior applies specifically to the bulk import wizard.

Importing into a template that uses Report Sections:

When your destination template has Report Sections turned on, the same category name can appear under more than one section (for example "General Condition" under two different sections). The wizard handles that explicitly:

  • Category pickers show "Section — Category". In search results and matching screens, each category reads as "Section — Category" so you can tell at a glance which section a match is about to land in. The wizard tracks each section's category as a distinct target, so two categories with the same name under different sections are never merged.
  • Section and category are saved on every row. After commit, every imported note carries the section, category, and subcategory you picked. A row that saves with a blank category or subcategory would become invisible in section-aware pickers during an inspection — treat that as a failed import and re-run it rather than accepting it.
  • Post-import review with bulk-approve. The final "keep / undo each row" step exists so you can confirm the AI's placements or resolve edge cases before the rows land. Use the bulk-approve action when the suggestions look correct so the review doesn't feel like a regression from the earlier automatic behavior. Once a note is saved, its section, category, and subcategory should read identically on the library card, in the edit dialog, and in the in-field "Add note" picker — mismatches between those views are a bug, not a display quirk.

Hide title on import

  • Notes only. You can hide note titles in the finished report either by mapping a Hide title column from your spreadsheet (values such as true, yes, or 1) or by turning on Hide title in report for all imported notes on the map-columns step. Defects ignore hide-title during import.
  • After import. You can still open any note in the library and change Hide title in the report manually. See Creating and Managing Notes.

Other Bulk Operations

Batch Updates: Update category or template associations for multiple comments Export Library: Create backups or share comments with colleagues Mass Deletion: Remove multiple unused comments at once

AI-Powered Organization

The system uses AI to help organize your library:

  • Duplicate Detection: Identify similar comments for consolidation
  • Category Suggestions: Recommend better categorization
  • Content Improvement: Suggest enhancements to comment content
  • Usage Optimization: Recommend library restructuring based on usage patterns

Search and Discovery

Keyword partial search: Split your query into terms; every term must appear in the comment text or its category/subcategory names. On the web Comments page, enter at least 3 characters; the mobile comment list has no minimum.

Similarity search: Background indexing ranks meaning-based near-matches for longer queries. Newly saved comments may take a few seconds to appear in similarity results.

Advanced filters: Filter by template, category, type, or usage Related Comments: Discover similar comments you might have missed Recent Activity: Quick access to recently used or created comments

Quality Assurance

Content Review Process

  1. Regular Audits: Review your comment library quarterly
  2. Accuracy Check: Verify technical accuracy and current standards
  3. Completeness Review: Ensure all necessary information is included
  4. Language Review: Check for clarity and professionalism

Maintenance Schedule

Monthly: Review most-used comments for accuracy Quarterly: Full library audit and cleanup Annually: Major reorganization and content updates As Needed: Updates based on industry changes or new requirements

Quality Standards

Technical Accuracy: Ensure all technical information is correct Professional Language: Use appropriate industry terminology Complete Information: Include all details necessary for action Actionable Recommendations: Provide specific, feasible solutions

Troubleshooting Common Issues

Comment Not Appearing in Search

Possible Causes:

  • Comment is in wrong category
  • Template association is incorrect
  • Search terms don't match content
  • Comment is marked as inactive

Solutions:

  • Check categorization and template assignment
  • Try different search terms
  • Verify comment status
  • Use filters to narrow search

Duplicate Comments

Causes:

  • Multiple similar comments created over time
  • Imported comments with variations
  • Different naming conventions for same issue

Solutions:

  • Use AI duplicate detection
  • Consolidate similar comments
  • Establish naming conventions
  • Regular library cleanup

Comments Not Relevant

Causes:

  • Outdated technical information
  • Changed industry standards
  • Template modifications
  • Scope changes

Solutions:

  • Regular content reviews
  • Industry standard updates
  • Template realignment
  • Scope adjustments

Integration with Other Features

Template Integration

Comments work seamlessly with your templates:

  • Organized by template categories and subcategories
  • Filtered by template for relevance
  • Updated when templates change
  • Imported from template systems

Observation Workflow

Comments integrate with the observation process:

  • Applied directly to observations
  • Customized for specific situations
  • Enhanced with photos and audio
  • Saved back to library with improvements

Reporting

Comments appear professionally in reports:

  • Consistent formatting across all reports
  • Proper categorization and organization
  • Integration with photos and other media
  • Export capabilities for various formats

Tips for Success

Getting Started

  1. Start with Common Issues: Begin with your most frequent observations
  2. Focus on Quality: Create comprehensive, well-written comments
  3. Use Real Examples: Base comments on actual inspection findings
  4. Test and Refine: Apply comments in real inspections and improve them

Building Your Library

  1. Consistent Addition: Add new comments regularly
  2. Variety Coverage: Include full range of possible observations
  3. Template Specific: Create comments for each template you use
  4. Seasonal Updates: Update comments for seasonal issues

Optimization

  1. Usage Analysis: Review which comments are most valuable
  2. Search Testing: Test search functionality with various terms
  3. Organization Review: Optimize categorization based on usage
  4. Content Updates: Keep comments current with industry standards

💡 Tip: The most successful comment libraries are those that grow organically from real inspection experience while maintaining high standards for quality and organization.

Next Steps

  1. Start Creating: Begin building your comment library with common observations
  2. Organize Systematically: Use templates and categories to structure your library
  3. Review and Refine: Regularly update and improve your comments
  4. Leverage Analytics: Use usage data to optimize your library organization

A well-organized comment library becomes an invaluable inspection tool that saves time, improves consistency, and enhances the quality of your reports. Invest time in creating and maintaining high-quality comments, and you'll see significant improvements in your inspection efficiency and report quality.

Related