Skip to content

Documentation style guidelines #14

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Open
avivace opened this issue Feb 8, 2020 · 2 comments
Open

Documentation style guidelines #14

avivace opened this issue Feb 8, 2020 · 2 comments
Labels
awaiting feedback consistency - style Content format, text style, consistency in presenting the informations content Improvements or additions to documentation
Milestone
v0.1.0

Comments

@avivace
Copy link
Member

avivace commented Feb 8, 2020 •
edited
Loading

Some guidelines on the style we should adopt/apply suggested by @Bananattack :

  • use consistent formatting;
  • any new information / rewrites should be written clearer than the original;
  • keep things concise and short;
  • don't repeat information like register/mode descriptions, reference/backlink to existing information instead;
  • present things as clear rules/definitions first, then explain or elaborate after.

Related issues:
#55
@avivace avivace added content Improvements or additions to documentation consistency - style Content format, text style, consistency in presenting the informations labels Feb 8, 2020
@avivace avivace added this to the v0.1.0 milestone Sep 8, 2020
@ISSOtm
Copy link
Member

ISSOtm commented Jul 14, 2021

What's the status on this?

@avivace
Copy link
Member Author

avivace commented Sep 15, 2021

What's the status on this?

WIP in the wiki

# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
awaiting feedback consistency - style Content format, text style, consistency in presenting the informations content Improvements or additions to documentation
Projects
None yet
Milestone
v0.1.0
Development

No branches or pull requests
2 participants
@avivace @ISSOtm