Giter Club home page Giter Club logo

Comments (3)

HarikalarKutusu avatar HarikalarKutusu commented on June 22, 2024

For what it's worth, in the past while working with Hillary, we talked about this a bit. In short, here is what I proposed:

  • Make use of readthedocs (it is free for open source, support github integration, document versions and multi-lingual documentation):
    • Use a Github repo common_voice/cv-documentation and link it to readthedocs
    • Create multiple localized branches, make locale leads moderator, but keep final control for formatting etc. The content (translation) should be under locale moderators.
    • You update the documentation through Github workflows (issues & PRs)
    • Whenever you need to mention something in WebApp, Discourse, Matrix, just point to the documentation. That would help support the load a lot.
  • Divide the documentation as follows:
    • General info on what is MCV, release timing, etc
    • Info on AI, Voice AI, how it is done (from text corpora to models - short info and external links)
    • User documentation (for WebApp - which is where)
    • Community Leads documentation (mostly from the community handbook)
    • Dataset user documentation (structure)
    • Developer documentation (how it works internally)
    • Terminology (needed to explain concepts like "variant" to the general population)
    • FAQ (for questions like "How much would I record", and "How can I add bulk sentences" - add "see: link" for these, ...)
    • Future development & how to contribute to code
    • etc

I kept a rather detailed documentation in Turkish in discourse and try to keep it up-to-date:
https://discourse.mozilla.org/t/surec-dogrular-yanlislar-ve-veri-kumesinin-iyilestirilmesi/85938
You may like to g-translate that to see what I mentioned. Except for causal users who record 5-10 sentences, you need to give them introductory info on AI and voice-AI to show them why it is the way it is. You'll also see locale-specific information, such as where to check for spelling, borrowed words in that language, etc - that is the reason Pontoon fails and you need multi-lingual branches on github.

I hope this helps...

Edit: Added "Terminology".

from common-voice.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.