Issue with "MDN Web 文档写作规范": (out-of-date document)

[yin1999]

MDN URL: https://developer.mozilla.org/zh-CN/docs/MDN/Guidelines/Writing_style_guide

What information was incorrect, unhelpful, or incomplete?

The document is out-of-date, which may confuse contributors.

Page report details

• Folder: zh-cn/mdn/guidelines/writing_style_guide
• MDN URL: https://developer.mozilla.org/zh-CN/docs/MDN/Guidelines/Writing_style_guide
• GitHub URL: https://github.com/mdn/translated-content/blob/main/files/zh-cn/mdn/guidelines/writing_style_guide/index.html
• Last commit: 6a0c7c9
• Document last modified: 2022-05-25T18:30:46.000Z

[awxiaoxian2020]

Are there any plans for this issue?

[yin1999]

Are there any plans for this issue?

I think it's better to complete the markdown convertion first (discussed with l10n-zh localization team), then working on those contribution documents. Or you can help to deal with this document (I'm glad to review).

There is still a lot of work needs to be done here.

[awxiaoxian2020]

Are there any plans for this issue?

I think it's better to complete the markdown convertion first (discussed with l10n-zh localization team), then working on those contribution documents. Or you can help to deal with this document (I'm glad to review).

There is still a lot of work needs to be done here.

As a new contributor of this repo, I haven't known the workflow about the "big event" like markdown convertion or a style of document yet. So I don't know how to contribute about these events. I just have some questions and suggestions.
questions:

• You said the doc is out-of-date. What does it mean? It doesn't sync with the English version?
• In the doc, we can see:

The language aspects of this guide apply primarily to English-language documentation. Other languages may have (and are welcome to create) style guides. These should be published as subpages of the localization team's page.

Are there subpages of l10n-zh team and some styles of Chinese? I need a reference link.

tips: These questions should have been solved by myself through looking into it. I will check sth. later but I'm glad if you can help me.

suggestions:

• Use the GitHub Project for this repo for some "big event" like what I said before.
• The MDN Web Docs is not only a doc but a website. But it's a doc mainly. We should give a brief doc of writing styles for contributors. Although there are some statements in our doc:

We are more interested in content than formatting, so don't feel obligated to learn the style guide before contributing.

But I think we should have a basic guide for writing.

• We can reference the React 中文文档译文排版指南 for the zh contributor doc if there are no details about it.

original purpose of commenting here:

when I'm working with #6162 , I haven't find some Chinese styles. It feels not so good.

[yin1999]

You said the doc is out-of-date. What does it mean? It doesn't sync with the English version?

Yes, we just keep the document the same as the english version (if not necessary, we will not add extra sentences)

Use the GitHub Project for this repo for some "big event" like what I said before.

We will consider this, like l10n-fr, l10n-ko.

The MDN Web Docs is not only a doc but a website. But it's a doc mainly. We should give a brief doc of writing styles for contributors. Although there are some statements in our doc

I'm still working on it (maybe just for markdown file), and it will be something like: https://github.com/mdn/translated-content/blob/main/docs/zh-tw/translation-guide.md. It will take us a lot of time to complete it, and if you have any suggestions, feel free to tell us (I will create a related PR later)

Thanks for your suggestion

[yin1999]

Use the GitHub Project for this repo for some "big event" like what I said before.

We will consider this, like l10n-fr, l10n-ko.

Setting up https://github.com/mdn/translated-content/projects/9

[awxiaoxian2020]

Hi, @yin1999
I try to review the doc and I found a 404 link.

translated-content/files/zh-cn/mdn/guidelines/writing_style_guide/index.html

Line 26 in 2291048

<p>译注：本文的写作规范虽说是针对英文所写，但是其中的不少内容也适用于中文，可花点时间阅读一下。另外，中文翻译时的规范请参见《<a href="https://developer.mozilla.org/zh-CN/docs/Glossary_of_translation">翻译术语表和翻译规范</a>》。</p>

Could you please check it? I don't know whether removing or correcting it.

[yin1999]

Could you please check it? I don't know whether removing or correcting it.

Just remove it.