How To Use and Organize This Space

Welcome to our newly structured Communities wiki! We hope that over the next few months, this space will be meticulously organized to serve as a centralized knowledge hub for all our engineering endeavors. This document provides an overview of our new structure and a guideline on how and when to transition documents from the "Old" section.

Overview of the New Structure

Home Page

  • Introduction to the engineering department.

  • Quick links to product-specific sections and general engineering sections.

  • Latest updates or news.

Product-Specific Sections

Each product line, such as Nurse, Physicians, and Wordpress blogs, has its dedicated section:

  1. Nurse

    • Overview: Introduction and key features of Nurse.

    • Getting Started (Onboarding)

    • Development: Specifics related to Nurse's codebase, environment, and APIs.

    • Features and Updates: Detailed insights into each feature and relevant updates.

    • Operations: Processes tailored for Nurse.

    • Training and Resources: Educational materials for Nurse.

    • Knowledge Base: FAQs and guides pertinent to Nurse.

  2. Physicians (Similar structure as Nurse but tailored to the Physicians product line. This will include FreeCME and Relias Media.)

  3. Wordpress Blogs (Adapted for the unique aspects of managing and developing WordPress blogs.)

  4. Relias Academy

  5. Wound Care

General Engineering Sections

  • Onboarding: Introduction to the department and team members, setup guides for software and tools, first week/month plans or checklists.

  • Infrastructure and Hardware: Details on shared infrastructure across products.

  • Project Management: Overarching methodologies and approaches.

  • Archives: Historical documentation and notes.

Old

  • Our previous documentation setup. Transition these documents to relevant product sections or general sections as appropriate.

Transitioning from "Old" to the New Structure

  1. Review the Document: Is it still accurate and relevant? Update any outdated content.

  2. Identify the Relevant Product: Determine if the document is specific to a product (e.g., Nurse) or if it's general engineering information.

  3. Categorize the Document: Within the product section (or general section), identify the most fitting subsection.

  4. Reformat if Necessary: Adhere to any new formatting or style guidelines.

  5. Move the Document: Transition it to the designated section.

  6. Update the "Old" Section: Once successfully moved and it's no longer needed in "Old", consider archiving or removing it to avoid duplication.

Contributing to Product Sections

Each product section is dedicated to maintaining up-to-date, comprehensive, and accessible information about that particular product. If you're contributing to a product section:

  • Ensure your content is specific to that product.

  • Adhere to any product-specific guidelines or standards.

  • Collaborate with product teams to verify information accuracy.

 

Remember, our goal is to maintain a cohesive, user-friendly, and valuable resource for all team members, regardless of the product they work on. Your feedback and suggestions to enhance this space are always welcome.