https://github.com/joshuacc/prose-for-programmers

A book to help software developers write better prose
https://github.com/joshuacc/prose-for-programmers

book

Last synced: 19 days ago
JSON representation

A book to help software developers write better prose

• Host: GitHub
• URL: https://github.com/joshuacc/prose-for-programmers
• Owner: joshuacc
• License: mit
• Created: 2015-03-04T15:23:12.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2023-04-17T23:53:48.000Z (almost 2 years ago)
• Last Synced: 2024-12-27T07:08:40.105Z (30 days ago)
• Topics: book
• Language: Nunjucks
• Homepage: https://proseforprogrammers.dev
• Size: 174 KB
• Stars: 226
• Watchers: 22
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-writing - Prose for Programmers
• starred-awesome - prose-for-programmers - A book to help software developers write better prose (Others)

README

        
# Prose for Programmers

This is a book for programmers.

It is a guide to mastering the most difficult programming language of all: human language.

Just as with programming,

we write with particular goals in mind.

That goal might be as simple as reminding someone about a requirement

or as complex as justifying an entirely new architecture for a product.

But in every case we write in order to achieve something.

This book will teach you how to achieve those goals more effectively with clearer, more persuasive writing.

## It is a work in progress

The first three chapters are content complete.

* [Why should developers study writing?](manuscript/why.md)

* [General Rules](manuscript/rules.md)

* [The Writing Process](manuscript/process.md)

And there are four chapters to come.

* Writing Structures

* Audience

* Genres

* Other Resources

For more detail, take a look at [the outline](outline.md).

## Can I get it in EPUB/MOBI/PDF?

[Yes, you can.](https://leanpub.com/proseforprogrammers)

## Contributing

* For general questions and suggestions, please [open an issue][issues].

* To correct typos or suggest specific changes in the way something is written, please [open a pull request][prs].

Note: By contributing content to this repository, you grant the book author (Joshua Clanton) a non-exclusive license to use that content in the book as he deems appropriate.

## License


Prose for Programmers by Joshua Clanton is licensed under a Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License.

[issues]:https://github.com/joshuacc/prose-for-programmers/issues

[prs]:https://github.com/joshuacc/prose-for-programmers/pulls