Topic on User talk:Pavithraes/Sandbox/New technical writers

Some feedback so far

2
SRodlund (WMF) (talkcontribs)

@pavithraesThis is looking good so far! I like the minimal structure and lean sentences, which make it easy for folks to skim for the information they need. The sections you have included are good for new users.


On the style guide page there is some information / suggestions for structuring pages. You should look at this section and think about structuring your page in a similar manner. That way your page will be more consistent with other documentation pages.


You may also want to look through the sections on styling. We generally have headings in sentence case rather than title case, so that it mirrors the way folks style headings on Wikipedia.


For the documentation users section, you may want to emphasize that these are the audiences for the docs and maybe include a little information on the type or style of documentation that might be most useful to each group. It's really useful for new writers to know who they are writing for, so I really like this section :-)


I especially like the suggestions for new users and think what you have included is definitely information they wouldn't know just by visiting pages. Any extra tips like these will be so helpful!


Thanks for working on this!

Pavithraes (talkcontribs)

@SRodlund (WMF) Thank you for this detailed feedback!

I think it's a great idea to specify the most useful docs for each user-group. Indeed, it would be quite helpful.

Thanks for pointing out the inconsistency in structure and styling of the page, I shall fix that.

Super glad that you liked the suggestions for newcomers. I hope readers add more based on their personal experience. :)

Reply to "Some feedback so far"