Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Misplaced Unity Guidelines #5

Open
greystar93 opened this issue Jul 30, 2015 · 2 comments
Open

Misplaced Unity Guidelines #5

greystar93 opened this issue Jul 30, 2015 · 2 comments

Comments

@greystar93
Copy link
Contributor

I question whether two of these guidelines belong in the English Style Guide:

  • animated GIFs Use animated GIFs only once for an operation. When repeating the operation, use either a screenshot or refer the reader back to the animated GIF. [Note: Changed gif to GIF, as per English Style Guide rule re: file extensions.]
  • spoilers Use spoilers to "quiz" readers on repeated operations in the tutorial.

I would argue these are writing guidelines. In fact, there's a section on animated GIFs in the Writing Guide.

I also wonder if these two guidelines can be applied to tutorials generally, not just to Unity tutorials? I think we need to move them somewhere, either to the Writing Guide or to a separate Unity guide.

@greystar93
Copy link
Contributor Author

@VegetarianZombie Could you move these to the Writing Guide? I don't have access. Thanks!

@crispy8888
Copy link
Contributor

@wlinc @greystar93 - serial comma note and examples have been added to the
guide. It's a bit redundant, seeing as we already note adherence to AP
style, but most authors wouldn't know that AP prescribes this style.

On the subject of menu navigation: echo whatever the casing is of the menu
item itself. If it's "Open file..." then use that. If it's "Kill with FIRE"
then use that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants