with sanic v21.3 released, the new sanic documentation were also released. And it’s support English and Chinese.
It’s real a exciting news. but there is also still many problems. I also think about these problems:
- How to make the style of documents more uniform ?
- How to make the work of translators easier ?
- How to make it easier to update these documents?
Therefore, we should specify a clear plan for the development of sanic documents in 2021.
The goal is to make document maintenance more convenient, easier and high-efficiency.
And this is our plan:
The theme of
sanic-guide program development this year is efficiency.
v21.6, customize a perfect writing format,
and try our best to ask all contributors to Create according to the writing standard:
Although we have many excellent document contributors,
the writing format of documents varies from person to person,
which brings great challenges to document display and translators translation work.
We urgently need a unified writing style to ensure the consistency of document display.
v21.9, Customize translation dictionaries for proper nouns:
We also have many contributors to document translation,
but because of the different translation habits,
the same proper noun is likely to be translated into different contents.
Therefore, we also need to customize a proper noun dictionary to help translators unify their translation style.
v21.12, Find the most efficient way to organize documents.
Our document now has 7 chapters and more than 50 documents. As time goes by, documents will become more and more.
New content is easily overlooked by translators. We need an effective way to help translators find the changed
content quickly and accurately.
This is only an initial plan. If you have any good suggestions, please say them.
We appreciate your opinions very much.