Document proofreading with linter, formatter and other tools?

[kazupon]

Motivation

We take into account the style of the translation so that it can be understood by the users.

However, just like OSS, documentation is translated by many different people. If there is no guideline for document translation, it may be hard to read the document, which may hinder the user's understanding.

Details

In OSS development, Lint tools are used to create unintentional bugs and to be standard code styles. As you know, in JavaScript, we use ESLint and Prettier to achieve this.

There are tools that is a similar mechanism for editing documentation text.

• textlint: https://textlint.github.io/

We use these tools, so we can provide users with documents that make for a consistent writing style.

Real-world cases

• Vue.js official documentation for Japanese
  • guideline: https://github.com/vuejs/jp.vuejs.org/blob/lang-ja/CONTRIBUTING.md
  • cusomized by JTF (Japan Translation Foundation) style guide
  • use textlint

[pi0]

Fully agree on reverting back textlint! We was using it for nuxt/docs. I even started a project back then to do spell check as well but never published 🙈 PR welcome to nuxt/nuxtjs.org adding it back 💚

There is also a very basic guideline for v3 English docs in https://github.com/nuxt/framework/issues/193 I guess we should move it to a more official namespace. Feel free to comment any improvement suggestions to it 👍

Regarding language-specific language guidelines, I FULLY AGREE but it is totally up to each community to set such guidelines. Do you mind helping to write one for Japanese or probably a general guideline how to make guideline for each language? We shall add it directly to this repo IMO (considering will be public soon)

[kazupon]

Regarding language-specific language guidelines, I FULLY AGREE but it is totally up to each community to set such guidelines.

Thank you for your interest!

About language-specific guideline, I agree that is set for each community.
We can't possibly handle all the other communities, so we don't have the God-like ability to understand all languages 😅

Do you mind helping to write one for Japanese or probably a general guideline how to make guideline for each language? We shall add it directly to this repo IMO (considering will be public soon)

Sure! 👍
Maybe, @nozomuikuta can help you with that 😺