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

Add "How to Write Technical Posts" guidelines to a document here #59

Open
chexxor opened this issue Mar 23, 2019 · 1 comment
Open

Add "How to Write Technical Posts" guidelines to a document here #59

chexxor opened this issue Mar 23, 2019 · 1 comment

Comments

@chexxor
Copy link
Owner

chexxor commented Mar 23, 2019

From #50 (comment)

We need to write this document in such a way that people will actually read it. (For example, see How to Write Technical Posts (so people will read them)

Thus, I'm trying to make things 'skimmable' by using:

  • nested headers with clear names
  • number lists
  • bullet lists
  • tables
  • 4 instead of "four"
  • small simple sentences
  • small paragraphs

I like this note and I think it would be helpful to put this in a place future PureScript documentation writers will see and apply it. This issue is a reminder to do this when someone sees an appropriate place in this project.

@JordanMartinez
Copy link
Contributor

If we continue with the idea of splitting the Context/Narrative into multiple files, I think it should go in the file that discusses the guidelines for doc writers.

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