Skip to content

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

Open
@chexxor

Description

@chexxor

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions