Documentation: 📚 Documentation & Tutorial Creator

[arn-c0de]

Overview

I'm looking for someone to help create setup guides, usage tutorials, and documentation for InteractiveChecklists. This includes written guides, screenshots, and potentially video/audio content.

Note:
You’re free to work on any part of the app Documentation, not just the listed priorities.

What I'm Looking For

A contributor who can help with:

• Setup guides — Step-by-step instructions for installing and configuring the app
• Feature tutorials — How to use PDF viewer, Markdown checklists, QuickNotes, tagging, etc.
• DCS integration docs — DataPad Server setup, Python Server/ App configuration, Aviation Map adn feature usage
• Screenshots — Clear, annotated images showing app features and workflows
• Video tutorials (optional) — Short walkthroughs for complex features
• Voiceover/narration (optional) — Audio explanations for video content

Skills That Would Help

• Clear, beginner-friendly writing style
• Experience with technical documentation
• Screenshot/image editing
• Video editing (nice to have)
• Familiarity with DCS World or flight simulation (helpful but not required)

What's In It For You

• Credit in COLLABORATORS.md, in-app contribution list and project documentation
• Experience contributing to a non-commercial Android/Kotlin project
• Help shape how users experience the app

How to Get Started

1. Comment on this issue if you're interested
2. Let me know which areas you'd like to focus on (written docs, images, video, etc.)
3. I'll provide access to the latest builds and answer any questions about features
4. Feel free to explore the app and identify documentation needs on your own – just submit your work for review

Note: During ongoing development, features and workflows may change over time.
Please check the changelog for recent updates and adjust the documentation accordingly if behavior or functionality has changed.

Documentation standard:
From now on, every documentation .md file must include the app version valid at the time of writing or last update (top or bottom of the file).
The version/date should only be updated when the file content has been actively changed.

Standard metadata block (to include in each .md file):

---
App Version: vX.Y.Z
Last Updated: YYYY-MM-DD
---

Current Documentation Gaps

User Guides

#	Task	Location hint	Active	Status	Contributor
1	Initial setup guide for new users	docs/user/setup.md or README	☐	Open
2	DCS integration guide	docs/user/dcs-integration.md	☐	Open
	└ Export.lua setup	docs/user/dcs-integration.md	☐	Open
	└ DCS Saved Games folder structure	docs/user/dcs-integration.md	☐	Open
3	DataPad + Python server configuration walkthrough (README_INSTALLER.md , README_LAUNCHER.md)	docs/user/server-setup.md	☐	Open
4	Aviation Map & route planning tutorial	docs/user/map-and-routing.md	☐	Open
5	QuickNotes usage guide	docs/user/quicknotes.md	☐	Open
6	PDF viewer overview	docs/user/viewers.md	☐	Open
7	MD viewer overview	docs/user/viewers.md	☐	Open

Video Guides

#	Task	Location hint	Active	Status	Contributor
1	App overview / feature tour	videos/ or YouTube	☐	Open
2	Checklists: Creating and using checklists	videos/	☐	Open
3	Install Export.lua and setup DataPad server	videos/	☐	Open
4	DCS integration walkthrough	videos/	☐	Open
5	Settings menus overview	videos/	☐	Open

Developer Guides

#	Task	Location hint	Active	Status	Contributor
1	Android app – install, build, run, modify, uninstall	docs/dev/android.md	☐	Open
2	Python server – install, configure, start/stop, modify, uninstall	docs/dev/server.md	☐	Open
3	Python database tools for marker management – install, use, modify, uninstall	docs/dev/tools.md	☐	Open
4	Project structure and architecture overview (all components)	docs/dev/architecture.md	☐	Open
5	Developer - Contributing guidelines	CONTRIBUTING.md	☐	Open
6	Developer - Contributing guidelines for third-party licenses	docs/dev/licenses.md or CONTRIBUTING.md	☐	Open

Contributor Guides

#	Task	Location hint	Active	Status	Contributor
1	Contributing guide for documentation	docs/CONTRIBUTING-docs.md	☐	Open
	└ 🌍 Add More Languages & Expand Translation Coverage #11	—	☐	Open
2	Contributing guide for adding new Markers	docs/CONTRIBUTING-markers.md	☐	Open
	└ 🗺️ Add map markers for a new DCS map #20	—	☐	Open

Documentation Maintenance

#	Task	Location hint	Active	Status	Contributor
1	Restructure README and move installation instructions into dedicated markdown files	README.md → docs/install/	☐	Open
2	Review existing documentation for accuracy	All docs/	☐	Open
3	Update outdated content or remove deprecated information	All docs/	☐	Open
4	Ensure consistency across all documentation	All docs/	☐	Open

Note: This list is not exhaustive. Contributors are encouraged to identify additional documentation needs and work on topics independently.

[eulucassoares]

Hello! I’m interested in contributing to this documentation effort.

I’m a visual designer and audiovisual producer, focused on creating beginner-friendly guides, visual tutorials, and short instructional videos for digital products.

I can specifically help with:

• Step-by-step setup and onboarding guides
• Feature tutorials with annotated screenshots
• Short walkthrough videos for more complex features

I have experience translating technical features into clear, user-focused documentation and media.
If helpful, I’d be glad to start with one of the current documentation gaps you listed (setup guide, QuickNotes, or app overview).
Let me know how you’d like to proceed.

[arn-c0de]

Hi @eulucassoares!

Great to hear from you – I'm really happy you want to help!

Current priorities:

• DataPad server setup – A clear, beginner-friendly guide covering installation and device registration via QR code
• Feature walkthroughs – Step-by-step tutorials for key app features like the PDF viewer, data import process, and Aviation Map functions (overlays, route planning, etc.)
• Review existing documentation – Check if current docs are still accurate and up to date, update or remove outdated content

You're also welcome to work on your own topics!

If you explore the app and identify areas that need documentation, feel free to draft guides or create content for those features. Just submit your work and I'll review it. Once we've aligned on the first topics and your contributions look good, I'll add you as an official contributor to the project.

Looking forward to working with you!

[drkaio7]

please assign i plan to work on it soon.