Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zainnobody/writing-samples

This GitHub repository showcases Zain's documentation work, including developer guides, portal user guides, SDK references, API references, tutorials, and release notes.
https://github.com/zainnobody/writing-samples

api-reference developer-guide documentation guides markdown portal-user-guide release-notes sample-docs sdk-reference technical-writing tutorials

Last synced: about 1 month ago
JSON representation

This GitHub repository showcases Zain's documentation work, including developer guides, portal user guides, SDK references, API references, tutorials, and release notes.

Awesome Lists containing this project

README 

        
# Sample Documentation



I'm **Zain**, and this repository showcases my most recent contributions and documentation work, including developer guides, portal user guides, SDK references, API references, tutorials, and release notes.



This README provides an overview of the content available in this repository, along with information on how to navigate and locate different types of documentation.



## Table of Contents



- [Repository Structure](#repository-structure)

- [Content Overview](#content-overview)

  - [Developer Guide](#developer-guide)

  - [Portal User Guide](#portal-user-guide)

  - [SDK Reference](#sdk-reference)

  - [API Reference](#api-reference)

  - [Release Notes](#release-notes)

  - [Tutorials](#tutorials)

- [Navigation Files](#navigation-files)

- [Contributing](#contributing)

- [License](#license)



## Repository Structure



The repository is organized into several directories, each containing markdown files related to a specific area of the documentation. Below is an outline of the main directories and their contents:



- [`developer-guide/`](developer-guide/): Contains the Developer Guide documentation.

- [`portal-guide/`](portal-guide/): Contains the Portal User Guide documentation.

- [`sdk-reference/`](sdk-reference/): Contains the SDK Reference documentation.

- [`api-reference/`](api-reference/): Contains the API Reference documentation.

- [`release-notes/`](release-notes/): Contains the Release Notes for different versions.

- [`tutorials/`](tutorials/): Contains tutorial documentation.

- [`README.md`](README.md): This file.



## Content Overview



### Developer Guide



The Developer Guide provides detailed instructions and information for developers working with our system. It includes topics such as getting started, installation, app creation, study management, study execution, and results analysis.



**Location**: [`developer-guide/`](developer-guide/)



**Key Sections and Files**:



- **Getting Started** ([`developer-guide/get-started/`](developer-guide/get-started/)):

  - [`overview.md`](developer-guide/get-started/overview.md): An overview of the system and how to get started.

  - [`create-account.md`](developer-guide/get-started/create-account.md): Instructions on creating an account.

  - [`contribute-to-the-project.md`](developer-guide/get-started/contribute-to-the-project.md): Guidelines on contributing to the open-source project.



- **Installation** ([`developer-guide/installation/`](developer-guide/installation/)):

  - [`install-backend.md`](developer-guide/installation/install-backend.md): Guide to installing the backend system.

  - [`install-sdk.md`](developer-guide/installation/install-sdk.md): Instructions for installing the App SDK.

  - [`install-portal.md`](developer-guide/installation/install-portal.md): Steps to install the web portal.

  - [`configure-database.md`](developer-guide/installation/configure-database.md): Instructions on connecting your database.



- **App Creation** ([`developer-guide/app-creation/`](developer-guide/app-creation/)):

  - [`create-app.md`](developer-guide/app-creation/create-app.md): Steps to build the mobile app.

  - [`configure-app.md`](developer-guide/app-creation/configure-app.md): Guide to configuring the app environment.

  - [`create-eligibility-questions.md`](developer-guide/app-creation/create-eligibility-questions.md): Instructions on configuring the eligibility survey.

  - [`test-app.md`](developer-guide/app-creation/test-app.md): Guidelines for testing the app.



- **Study Management** ([`developer-guide/study-management/`](developer-guide/study-management/)):

  - [`create-study.md`](developer-guide/study-management/create-study.md): Guide to creating a new study.

  - [`dev-manage-members.md`](developer-guide/study-management/dev-manage-members.md): Information on managing team members.



- **Content Creation** ([`developer-guide/content-creation/`](developer-guide/content-creation/)):

  - [`create-survey.md`](developer-guide/content-creation/create-survey.md): Steps to create a survey.

  - [`preview-survey.md`](developer-guide/content-creation/preview-survey.md): How to preview a survey before publishing.

  - [`publish-survey.md`](developer-guide/content-creation/publish-survey.md): Instructions on scheduling and publishing a survey.



- **Study Execution** ([`developer-guide/study-execution/`](developer-guide/study-execution/)):

  - [`onboard-participants.md`](developer-guide/study-execution/onboard-participants.md): How to onboard participants into the study.

  - [`collect-data.md`](developer-guide/study-execution/collect-data.md): Instructions on data collection processes.



- **Results Analysis** ([`developer-guide/results-analysis/`](developer-guide/results-analysis/)):

  - [`view-graphs.md`](developer-guide/results-analysis/view-graphs.md): How to view graphs and charts of collected data.

  - [`run-query.md`](developer-guide/results-analysis/run-query.md): Instructions on running data queries.

  - [`view-individual-results.md`](developer-guide/results-analysis/view-individual-results.md): Guide to viewing individual participant results.

  - [`export-data.md`](developer-guide/results-analysis/export-data.md): Steps to export data for external analysis.



### Portal User Guide



The Portal User Guide is intended for users interacting with the web portal, providing instructions and information on study management, content creation, study execution, and results analysis.



**Location**: [`portal-guide/`](portal-guide/)



**Key Sections and Files**:



- **Study Management** ([`portal-guide/study-management/`](portal-guide/study-management/)):

  - [`creating-a-study.md`](portal-guide/study-management/creating-a-study.md): Guide to creating a study through the portal.

  - [`role-based-access-control.md`](portal-guide/study-management/role-based-access-control.md): Information on role-based access control (RBAC).

  - [`portal-manage-members.md`](portal-guide/study-management/portal-manage-members.md): Instructions on managing team members via the portal.



- **Content Creation** ([`portal-guide/content-creation/`](portal-guide/content-creation/)):

  - [`creating-a-survey.md`](portal-guide/content-creation/creating-a-survey.md): Steps to create a survey within the portal.

  - [`previewing-a-survey.md`](portal-guide/content-creation/previewing-a-survey.md): How to preview a survey before it goes live.

  - [`publishing-a-survey.md`](portal-guide/content-creation/publishing-a-survey.md): Instructions on scheduling and publishing surveys.



- **Study Execution** ([`portal-guide/study-execution/`](portal-guide/study-execution/)):

  - [`onboarding-participants.md`](portal-guide/study-execution/onboarding-participants.md): Guide to onboarding participants using the portal.

  - [`collecting-data.md`](portal-guide/study-execution/collecting-data.md): Instructions on collecting data from participants.

  - [`tracking-survey-responses.md`](portal-guide/study-execution/tracking-survey-responses.md): How to track survey responses.

  - [`viewing-survey-analytics.md`](portal-guide/study-execution/viewing-survey-analytics.md): Guide to viewing survey analytics and metrics.



- **Results Analysis** ([`portal-guide/results-analysis/`](portal-guide/results-analysis/)):

  - [`viewing-graphs.md`](portal-guide/results-analysis/viewing-graphs.md): Instructions on viewing graphs and charts within the portal.

  - [`running-a-query.md`](portal-guide/results-analysis/running-a-query.md): How to run data queries directly in the portal.

  - [`viewing-individual-results.md`](portal-guide/results-analysis/viewing-individual-results.md): Guide to accessing individual participant results.

  - [`exporting-data.md`](portal-guide/results-analysis/exporting-data.md): Instructions on exporting data for external use.



### SDK Reference



The SDK Reference provides detailed documentation on the SDK packages, including classes, methods, and usage examples.



**Location**: [`sdk-reference/`](sdk-reference/)



**Key Sections and Files**:



- **Kit** ([`sdk-reference/kit/`](sdk-reference/kit/)):

  - [`kit.md`](sdk-reference/kit/kit.md): Overview and documentation for the Kit SDK.

  - [`healthstack.kit.auth/`](sdk-reference/kit/healthstack.kit.auth/): Authentication module documentation.

  - [`healthstack.kit.task.survey/`](sdk-reference/kit/healthstack.kit.task.survey/): Survey task implementation details.

  - [`healthstack.kit.ui/`](sdk-reference/kit/healthstack.kit.ui/): UI components and utilities.



- **App Support** ([`sdk-reference/app-support/`](sdk-reference/app-support/)):

  - [`app-support.md`](sdk-reference/app-support/app-support.md): Documentation for the App Support SDK.

  - [`healthstack.app.sync/`](sdk-reference/app-support/healthstack.app.sync/): Details on synchronization mechanisms.

  - [`healthstack.app.viewmodel/`](sdk-reference/app-support/healthstack.app.viewmodel/): ViewModel implementations.



- **Backend Integration** ([`sdk-reference/backend-integration/`](sdk-reference/backend-integration/)):

  - [`bi_interface.md`](sdk-reference/backend-integration/bi_interface.md): Interface documentation for backend integration.

  - [`healthstack-adapter.md`](sdk-reference/backend-integration/healthstack-adapter.md): Information on the HealthStack adapter.



- **Health Data Link** ([`sdk-reference/healthdata-link/`](sdk-reference/healthdata-link/)):

  - [`hl_interface.md`](sdk-reference/healthdata-link/hl_interface.md): Interface documentation for Health Data Link.

  - [`healthconnect.md`](sdk-reference/healthdata-link/healthconnect.md): Details on integrating with HealthConnect.

  - [`healthplatform.md`](sdk-reference/healthdata-link/healthplatform.md): Information on HealthPlatform integration.



### API Reference



The API Reference provides comprehensive documentation on the API endpoints, including request and response formats.



**Location**: [`api-reference/`](api-reference/)



**Key Files**:



- [`api-overview.md`](api-reference/api-overview.md): Overview of the APIs and their usage.

- [`account-service-api-endpoints.md`](api-reference/account-service-api-endpoints.md): Documentation for account service API endpoints.

- [`study-api-endpoints.md`](api-reference/study-api-endpoints.md): Documentation for study management API endpoints.

- [`data-query-service-api-endpoints.md`](api-reference/data-query-service-api-endpoints.md): Documentation for data query service API endpoints.



### Release Notes



The Release Notes section contains information about different versions, including new features, bug fixes, and known issues.



**Location**: [`release-notes/`](release-notes/)



**Key Files**:



- [`v09beta.md`](release-notes/v09beta.md): Release notes for version 0.9 beta.

- [`v09alpha.md`](release-notes/v09alpha.md): Release notes for version 0.9 alpha.



### Tutorials



The Tutorials section provides step-by-step guides to help users understand and use various features.



**Location**: [`tutorials/`](tutorials/)



**Key Files**:



- [`HealthStack Kit Tutorial Creating a Custom Task.md`](tutorials/HealthStack%20Kit%20Tutorial%20Creating%20a%20Custom%20Task.md): Instructions on creating a custom task using HealthStack Kit.

- [`Using HealthStack Backend Integration.md`](tutorials/Using%20HealthStack%20Backend%20Integration.md): Guide on integrating with HealthStack backend.

- [`Health Data Link - Tutorial.md`](tutorials/Health%20Data%20Link%20-%20Tutorial.md): Tutorial on using Health Data Link.



## Navigation Files



The repository includes navigation files that define the structure of the documentation, often used for generating sidebars or tables of contents in documentation websites.



**Key Files**:



- **Navigation Files**:

  - [`nav-developer-guide.yaml`](nav-developer-guide.yaml): Defines the navigation structure for the Developer Guide.

  - [`nav-portal-guide.yaml`](nav-portal-guide.yaml): Defines the navigation for the Portal User Guide.

  - [`nav-sdk-reference.yaml`](nav-sdk-reference.yaml): Organizes the SDK Reference documentation.

  - [`nav-api-reference.yaml`](nav-api-reference.yaml): Structures the API Reference section.

  - [`nav-release-notes.yaml`](nav-release-notes.yaml): Outlines the Release Notes for different versions.



These navigation files can be used to understand how the documentation is organized and are helpful when generating documentation websites or PDFs.



---



## Thank You!



Thank you for taking the time to explore this repository. I hope you find the documentation helpful and insightful for your projects and learning. Your feedback is incredibly valuable, and I’m always looking to improve.



If there’s anything you didn’t like, found confusing, or feel could be improved, please don’t hesitate to [open an issue](https://github.com/zainnobody/writing-samples/issues) or reach out directly. Contributions, suggestions, and ideas are always welcome!



Feel free to share this repository with others who might find it useful. Together, we can make it even better.



Happy documenting,  



**Zain**