Guide: In-App Help (HelpGuide)

Overview

The In-App Help system (HelpGuide) is designed to provide administrators with immediate assistance directly on management screens. It appears as a help icon (?) at the top right of complex screens.

Features

  • Quick Access: Screen-specific help is accessible with a single click.
  • Cross-Platform: Available on both the Web dashboard and the Admin mobile app.
  • Multilingual: All help content is translated into the 5 supported languages (French, English, Spanish, Portuguese, Swahili).
  • Clear Format: Help is presented in numbered sections with a title and a concise explanation.

Supported Screens

Contextual help is currently available on the following screens:

  • Dashboard: Overview of key indicators.
  • Member Management: Help for adding and editing members.
  • Contribution Management: Guide for creating new contributions.
  • Manual Payments: Instructions for validating payment proofs.
  • Expenses: Help for recording fund outflows.
  • Information: Guide for publishing announcements.
  • Meetings: Help for scheduling meetings.
  • Admin Management: Explanation of roles and invitations.

Icon Meanings (Payments)

In payment guides, you may encounter these symbols:

  • 🌍: Global payment method (usable anywhere).
  • 🇨🇮: Local payment method (e.g., country-specific Mobile Money).

To improve the user experience on screens with long lists or numerous forms (such as members, contributions, or initial setup), a "Scroll to Top" button appears automatically as soon as you scroll down the page.

  • Visibility: The button appears after a short scroll.
  • Action: A single tap instantly brings you back to the top of the screen, making it easier to access headers and navigation menus.

Maintenance

The content of these guides is centralized in translation files (helpGuides namespace). Any changes made to the help text on one platform are automatically synchronized to the other (Web/Mobile) to ensure a consistent experience.