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

Technical writing panel (documentation edition) #38

Open
brunogirin opened this issue Aug 10, 2020 · 0 comments
Open

Technical writing panel (documentation edition) #38

brunogirin opened this issue Aug 10, 2020 · 0 comments
Labels
To discuss The topic we'll be discussing at the next codebar chapter organiser meeting

Comments

@brunogirin
Copy link

There has been a fair amount of interest in the first technical writing panel and it generated a few tweets. This one from Jo Petty suggests that we should have more technical writers on the panel. This points to the fact that "technical writing" is an overloaded term and means at least the following two things:

  • Writing articles and books for developers (the subject of the first panel)
  • Writing product documentation, either for a technical or non-technical audience (what I think Jo does)

Assuming the first panel is a success, we could do another one focused on the latter, that could cover:

  • Code documentation (what you put in the documentation comments),
  • Technical libraries documentation and tutorials,
  • User manuals for non-technical audiences.
@KimberleyCook KimberleyCook added the To discuss The topic we'll be discussing at the next codebar chapter organiser meeting label Aug 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
To discuss The topic we'll be discussing at the next codebar chapter organiser meeting
Projects
None yet
Development

No branches or pull requests

2 participants