-
Notifications
You must be signed in to change notification settings - Fork 0
Description
3md Project Roadmap
Version: 0.1.0 → 1.0.0 and Beyond
Last Updated: December 29, 2025
Status: Active Development
Table of Contents
- Vision & Strategic Goals
- Current State Assessment
- Roadmap Phases
- Adoption Strategy
- Action Items by Priority
- Success Metrics
- Risk Mitigation
Vision & Strategic Goals
Long-term Vision (3-5 years)
Establish 3md as the de facto standard for trilingual content management in Sri Lanka, with:
- Adoption by major cultural institutions (museums, libraries, archives)
- Integration into government publishing workflows
- Use in educational institutions for multilingual textbooks
- Active developer ecosystem with tools in multiple programming languages
- Recognition as a sustainable open infrastructure project
Strategic Priorities
- Specification Stability: Reach v1.0.0 with backward compatibility guarantee
- Tool Ecosystem: Enable easy integration into existing workflows
- Community Building: Create active contributor and user communities
- Real-world Validation: Demonstrate value through pilot implementations
- Sustainability: Establish governance and long-term maintenance structure
Current State Assessment
✅ What's Strong
- Solid Foundation: Well-documented specification (1651 lines)
- Reference Implementation: Working TypeScript/JavaScript parser
- Clear Use Cases: Documented real-world problems and solutions
- Open License: CC BY 4.0 spec, MIT code
- Interactive Playground: Browser-based testing environment
- Comprehensive Testing: Error handling specification with 19 codes
⚠️ What Needs Work
- No Public Implementations: No live deployments showcasing the format
- Single Language Support: Only TypeScript/JavaScript parser exists
- Limited Tooling: No editors, converters, or integrations
- No Community: No contributors outside core team
- Unproven in Production: No case studies or testimonials
- Breaking Changes Possible: Still pre-v1.0.0
Roadmap Phases
Phase 1: Stabilization (Q1-Q2 2026)
Goal: Reach specification v1.0.0 with backward compatibility commitment
Specification Work
- Gather feedback from 5-10 early adopters
- Test edge cases with real-world content (100+ page documents)
- Validate performance characteristics with large files
- Review and finalize error handling codes
- Document migration path from 0.x to 1.0
- Publish v1.0.0-rc1, rc2, then stable
Parser Enhancement
- Achieve 100% CommonMark spec compliance
- Add comprehensive benchmarking suite
- Optimize for files >10,000 lines
- Add streaming API for large documents
- Improve error messages with actionable suggestions
- Add validation mode (lint 3md files)
- Publish to npm with v1.0.0 specification alignment
Documentation
- Create migration guide from common formats (separate MD files, DOCX)
- Write "How to Choose Between ~ and ෴" guide
- Add troubleshooting section to README
- Create video tutorials (5-10 minutes each)
- Document best practices for different content types
Milestone: v1.0.0 specification release with stable parser
Phase 2: Ecosystem Building (Q2-Q3 2026)
Goal: Create essential tools that demonstrate practical value
Core Tools Development
-
3md CLI Tool (Node.js)
- Convert 3md → separate MD files
- Convert separate MD files → 3md (merge tool)
- Validate and lint 3md files
- Statistics (word counts per language, coverage)
- Diff tool (compare translations side-by-side)
-
Web Editor (Browser-based)
- Split-pane view (source + live preview)
- Syntax highlighting for separators
- Real-time validation
- Export to HTML, PDF, DOCX
- Shareable links for collaboration
-
VS Code Extension
- Syntax highlighting
- IntelliSense for language codes
- Quick actions (insert separators)
- Preview pane (split by language)
- Validation on save
Integration Tools
-
Pandoc Filter (Lua)
- Convert 3md → DOCX, PDF, HTML, EPUB
- Template system for styling
- Custom Pandoc writer for 3md
-
Hugo/Jekyll Plugins
- Process 3md files in static site generators
- Generate multilingual websites
- Language switcher components
-
Python Parser
- Port reference implementation
- Integrate with Sphinx documentation
- Enable Python-based publishing workflows
Converters
- Word/DOCX → 3md converter (for migration)
- InDesign → 3md export script (JavaScript)
- Google Docs → 3md (Apps Script)
- 3md → InDesign data merge format
Milestone: 5+ production-ready tools available
Phase 3: Adoption & Pilot Programs (Q3-Q4 2026)
Goal: Achieve 3-5 real-world implementations with case studies
Pilot Partnerships
Target Organizations:
-
Cultural Heritage (High Priority)
- National Museum of Colombo
- Archaeological Department
- National Archives
- Buddhist Publication Society
Pitch: "Preserve exhibit labels, research papers, and archival descriptions in a future-proof format that survives software obsolescence"
-
Educational Institutions (High Priority)
- University departments (History, Archaeology, Languages)
- Educational Publications Department
- Textbook publishers
Pitch: "Streamline trilingual textbook production with version control and collaborative editing"
-
Government Agencies (Medium Priority)
- Department of Official Languages
- Government Information Department
- Local government bodies (municipal councils)
Pitch: "Reduce translation errors and maintain consistency across government communications"
-
NGOs & Civil Society (Medium Priority)
- Transparency International Sri Lanka
- Centre for Policy Alternatives
- Grassroots organizations publishing reports
Pitch: "Make research and advocacy materials accessible in all three languages with minimal overhead"
-
Publishing & Media (Lower Priority Initially)
- Small independent publishers
- Bilingual/trilingual magazines
- Online news platforms
Pitch: "Automate multilingual content workflows and reduce publication costs"
Pilot Program Structure
- Provide free consultation and tool customization
- Hands-on training workshops (half-day sessions)
- Technical support for 6 months
- Co-create case studies documenting:
- Problem before 3md
- Implementation process
- Time/cost savings
- Lessons learned
- Request testimonials and references
Deliverables from Pilots
- 3-5 published case studies
- Video testimonials from users
- Documented workflow examples
- Refinements to specification based on feedback
- Templates for common use cases (museum labels, reports, textbooks)
Milestone: 3 organizations actively using 3md in production
Phase 4: Community & Scale (2027)
Goal: Build self-sustaining community and expand beyond Sri Lanka
Community Building
- Launch community forum/Discord (Sinhala/Tamil/English)
- Monthly virtual meetups
- Contributor guidelines and governance model
- Mentorship program for new contributors
- Translation bounties (translate docs to Sinhala/Tamil)
- Annual 3md Conference (virtual/hybrid)
Developer Ecosystem
- Ports to other languages (Rust, Go, Java, PHP)
- Plugin API specification
- Theme/template marketplace
- Integration examples for popular CMSs (WordPress, Drupal)
- GitHub Actions for CI/CD workflows
- Docker images for batch processing
Geographic Expansion
-
Adapt format for other trilingual contexts:
- Canada (English/French/Indigenous languages)
- Belgium (Dutch/French/German)
- Switzerland (German/French/Italian/Romansh)
- India (Hindi/English/regional languages)
- Multilingual Africa contexts
-
Generalize specification to n languages (3md → nmd?)
-
Locale-specific separator alternatives
Sustainability
- Establish governance structure (steering committee)
- Explore funding models:
- Grant applications (cultural preservation, digital infrastructure)
- Sponsorship from benefiting organizations
- Paid support contracts
- Training revenue
- Trademark registration for 3md
- Long-term hosting and maintenance plan
Milestone: 20+ active contributors, 50+ production deployments
Adoption Strategy
The Adoption Funnel
AWARENESS → INTEREST → TRIAL → ADOPTION → ADVOCACY
1. Awareness Building
Content Marketing
- Blog series: "Why Trilingual Publishing is Broken" (problem-focused)
- Case study articles: "How X Museum Saved 100 Hours with 3md"
- Technical deep dives: Published on Dev.to, Medium, local tech blogs
- Academic paper: Present at digital humanities conferences
- Infographics: Visual comparison of old vs. new workflows
Speaking & Events
- Present at Wikimedia Conference Sri Lanka
- Workshop at FOSS.lk (Free and Open Source Software Sri Lanka)
- Guest lectures at university CS/IT departments
- Meetup.com group: "Multilingual Tech Sri Lanka"
- Lightning talks at tech meetups (Colombo JS, Python Sri Lanka)
Press & Media
- Press release to tech media (LankaIOT, Readme.lk, Tech.lk)
- Pitch to Daily FT, The Island (business/tech sections)
- Interview on tech podcasts (if available)
- Social media campaign (Twitter/X, LinkedIn, Mastodon)
- #MultilingualSriLanka
- #OpenStandards
- #DigitalHeritage
Academic Outreach
- Contact Digital Humanities departments
- Collaborate with language technology researchers
- Submit to open-source academic conferences
- Publish specification in academic repository (Zenodo)
- Get DOI for citability
2. Interest Generation
Show, Don't Just Tell
- Live Demos: 30-second video showing 3md → beautiful output
- Interactive Playground: Make it prominent on website
- Before/After Comparisons: Show workflow simplification
- Cost Calculator: "How much time could you save?"
- Template Gallery: Ready-to-use examples for common needs
Educational Content
- Comprehensive tutorial series (beginner to advanced)
- Webinar series (monthly, recorded)
- FAQ addressing common objections
- Comparison table: 3md vs. alternatives
- Email course: "7 Days to Trilingual Mastery"
3. Trial Facilitation
Lower Barriers to Entry
- 5-minute quickstart: Zero-install browser experience
- Migration script: Convert existing content automatically
- Templates: Start from working examples, not blank files
- Sandbox environment: Test without commitment
- Free consultation: 30-minute calls with interested organizations
Support Infrastructure
- Clear documentation (assume no prior knowledge)
- Video walkthroughs for each tool
- Community support forum
- Stack Overflow tag
- Troubleshooting decision tree
4. Adoption Enablement
Remove Obstacles
- Integration guides: How to fit 3md into existing workflows
- Training materials: For teams, not just individuals
- Success templates: Proven workflows from pilot programs
- Migration support: Help move from old systems
- ROI calculator: Justify investment to stakeholders
Build Confidence
- v1.0 stability guarantee
- Backward compatibility promise
- Long-term support commitment
- Testimonials from respected organizations
- Third-party endorsements (standards bodies, academics)
5. Advocacy Cultivation
Turn Users into Champions
- Featured user spotlights
- Contributor recognition program
- Speaker bureau (train users to present)
- Referral incentives (free support hours)
- Co-branding opportunities
Make Sharing Easy
- Social media share buttons with pre-written text
- "Powered by 3md" badge for websites
- Slide deck template for internal pitches
- One-pager for executives
- Success story templates
Action Items by Priority
Immediate (Next 30 Days)
Specification
- Create GitHub Discussions for specification feedback
- Draft v1.0.0-rc1 changelog
- Identify 3 organizations for alpha testing
Community
4. [ ] Set up project website (GitHub Pages)
5. [ ] Create social media accounts (Twitter/X, LinkedIn)
6. [ ] Write launch announcement blog post
7. [ ] Post on Hacker News, Reddit (r/programming, r/srilanka)
Code
8. [ ] Publish parser to npm registry
9. [ ] Add installation instructions to README
10. [ ] Create simple CLI tool demo video
Outreach
11. [ ] Contact 5 potential pilot organizations via email
12. [ ] Submit talk proposal to FOSS.lk 2026
13. [ ] Reach out to 3 tech bloggers/podcasters
Short-term (2-3 Months)
Specification
14. [ ] Incorporate alpha tester feedback
15. [ ] Publish v1.0.0-rc1
16. [ ] Begin v1.0.0 conformance test suite
Tools
17. [ ] Build basic web editor (MVP)
18. [ ] Create VS Code extension (syntax highlighting only)
19. [ ] Develop 3md validation CLI
20. [ ] Create migration tool (separate MD → 3md)
Documentation
21. [ ] Record 3 tutorial videos (basics, advanced, integrations)
22. [ ] Write 5 blog posts for launch campaign
23. [ ] Translate README to Sinhala and Tamil
24. [ ] Create one-page explainer for non-technical audiences
Community
25. [ ] Host first virtual meetup
26. [ ] Establish contributor guidelines
27. [ ] Create project roadmap (this document!) and publish it
Pilots
28. [ ] Secure 1st pilot partnership agreement
29. [ ] Conduct first workshop
30. [ ] Begin case study documentation
Medium-term (3-6 Months)
Specification
31. [ ] Release v1.0.0 stable
32. [ ] Publish formal announcement
33. [ ] Submit to standards body consideration (ISO/W3C exploratory)
Ecosystem
34. [ ] Launch 3md.org website
35. [ ] Pandoc filter implementation
36. [ ] Python parser release
37. [ ] InDesign integration example
38. [ ] Template marketplace (GitHub repo)
Adoption
39. [ ] Complete 3 pilot programs
40. [ ] Publish 3 case studies
41. [ ] Present at 2 conferences
42. [ ] Secure 10 production deployments
Community
43. [ ] Reach 100 GitHub stars
44. [ ] 5+ external contributors
45. [ ] Active forum with 50+ members
46. [ ] Monthly newsletter launch
Long-term (6-12 Months)
Maturity
47. [ ] Specification v1.1 (minor improvements based on usage)
48. [ ] 5 language implementations (TS, Python, Rust, Go, Java)
49. [ ] Comprehensive tool ecosystem (10+ tools)
50. [ ] Integration with major platforms (Hugo, Jekyll, WordPress)
Scale
51. [ ] 50+ organizations using 3md
52. [ ] 1000+ GitHub stars
53. [ ] Active contributor community (20+ people)
54. [ ] Self-sustaining forum/support community
Impact
55. [ ] Academic citations and research papers
56. [ ] Government adoption (at least 1 ministry/department)
57. [ ] Educational institution adoption (textbook publishers)
58. [ ] International recognition (non-Sri Lanka usage)
Sustainability
59. [ ] Governance structure established
60. [ ] Funding secured for 2+ years of development
61. [ ] Annual conference established
62. [ ] Long-term roadmap through 2030
Success Metrics
Technical Metrics
- Specification Maturity: v1.0.0 published with <5 breaking changes in first year
- Parser Performance: <100ms for 10,000 line documents
- Test Coverage: >90% code coverage
- CommonMark Compliance: 100% of CommonMark spec tests passing
Adoption Metrics
- Active Installations: 50+ organizations by end of 2026
- Tool Downloads: 1,000+ monthly npm downloads
- Community Size: 500+ forum members, 20+ active contributors
- Content Volume: 10,000+ documents created in 3md format
Impact Metrics
- Time Savings: 40% average reduction in multilingual publishing time (user surveys)
- Error Reduction: 50% fewer translation sync issues (case studies)
- Cost Savings: Document 100,000+ USD in organizational savings
- Accessibility: 100+ cultural heritage items made trilingual that weren't before
Awareness Metrics
- Website Traffic: 5,000+ monthly visitors
- Social Reach: 2,000+ followers across platforms
- Media Mentions: 20+ articles/blog posts/podcast features
- GitHub Stars: 1,000+
- Video Views: 10,000+ total across tutorials
Risk Mitigation
Risk: Specification Changes Break Existing Content
Mitigation:
- Version specification clearly (semver)
- Maintain parser compatibility for deprecated features
- Provide automated migration tools
- Give 6-month deprecation warnings
- Publish detailed changelog for every release
Risk: Low Adoption Due to "Not Invented Here" Syndrome
Mitigation:
- Emphasize open standard (not product)
- Show clear cost/benefit
- Pilot with respected institutions first (social proof)
- Make easy to try without commitment
- Provide migration tools from existing formats
Risk: Single Implementation Limits Adoption
Mitigation:
- Prioritize reference implementations in popular languages
- Document parser architecture clearly
- Offer bounties for new implementations
- Partner with universities for student projects
- Make specification clear enough to implement independently
Risk: Format Perceived as Too Niche
Mitigation:
- Document generalization to n languages
- Build international partnerships
- Present at international conferences
- Show applicability beyond Sri Lanka
- Create case studies in multiple contexts
Risk: Competing Standards Emerge
Mitigation:
- Move fast on v1.0.0 release
- Build strong community early
- Focus on superior user experience
- Establish partnerships with key institutions
- Publish specification openly (others can contribute)
Risk: Lack of Funding for Long-term Maintenance
Mitigation:
- Apply for digital infrastructure grants
- Explore institutional sponsorships
- Offer paid support/training
- Build sustainable community of contributors
- Keep core specification simple (low maintenance)
Risk: Key Contributors Leave Project
Mitigation:
- Document everything extensively
- Share knowledge across team
- Build contributor pipeline early
- Establish governance structure
- Make codebase approachable for new contributors
Call to Action
For Project Team
- This Week: Publish roadmap to GitHub and announce on social media
- This Month: Reach out to first 5 pilot organizations
- This Quarter: Ship v1.0.0-rc1 and basic web editor
For Potential Contributors
- Review specification and provide feedback
- Implement parser in your preferred language
- Create tools for your workflow
- Share 3md with your network
- Report issues and suggest improvements
For Organizations
- Test 3md with real content
- Provide feedback on pain points
- Consider pilot program participation
- Share your use case
- Sponsor development if it provides value
Resources & Next Steps
Essential Links (to be created):
- Project Website: https://3md.org (pending)
- GitHub Repository: https://github.com/mooniak/3md
- Discussion Forum: GitHub Discussions
- Chat: Discord/Matrix (to be set up)
- Newsletter: Signup form (to be created)
Contact:
- Project Lead: [Contact information]
- Partnership Inquiries: [Email]
- Press & Media: [Email]
Stay Updated:
- Watch GitHub repository
- Follow social media accounts
- Join mailing list
- Attend monthly meetups
Document Maintenance:
This roadmap is a living document. It will be reviewed and updated quarterly based on progress, community feedback, and changing priorities.
Last reviewed: December 29, 2025
Next review: March 31, 2026
Version: 1.0