+1, Great stuff. I am wondering if there is some tool to check it automatically? like code-style check.
Thanks, Haiting On 2021/12/15 03:17:45 Yu wrote: > Hi Pulsar enthusiasts, > > > As you may notice, there are more and more documentation contributions > nowadays, which is great! > > > Similar to coding style guides, in the field of technical writing, a > writing style guide is a must to improve users' experience and eliminate > writers' workload. > > > To improve the doc quality, I create our style guide — *Pulsar Writing > Style Guide* [1] > > > # Definition > > > Pulsar Writing Style Guide contains a set of standards for writing and > designing content. > > > It helps maintain a consistent style, voice, and tone across Pulsar > documentation. > > > This guide is inspired by some existing style guides. It references *IBM > Style Guide*, *Chicago Manual of Style*, and other books for more > exhaustive guidance. > > > # Benefits > > > Pulsar Writing Style Guide can improve the content quality and bring many > benefits to users and writers like: > > > For users: > > - Make documentation easier to read > > - Reduce users’ cognitive load > > - Increase users' confidence in the content’s authority > > > For information developers: > > - Resolve arguments and support our needs to create readable, usable, and > minimalist information > > - Save time and trouble by providing a single reference for writing about > common topics, features, and more > > - Help write documentation in a clearer way and keep a consistent tone of > voice and style > > > >>>>>> > > > This guide is not a one-shot job, the current version is an initial draft. > I'll make continuous efforts on that. > > > I believe that the Pulsar community will welcome this addition to our > resources and profit from the instructions. > > > Feel free to comment, thanks. > > > [1] > https://docs.google.com/document/d/1lc5j4RtuLIzlEYCBo97AC8-U_3Erzs_lxpkDuseU0n4/edit# >
