Skip to content

Steve-O-Murphy/Docs-Like-Code

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 

Repository files navigation

Docs-Like-Code

What is docs-as-code?

Docs-as-code is an approach to writing and publishing documentation with the same tools and processes developers use to create code.

The developer approach

Developers do the following:

  1. Author code.
  2. Create some kind of executable.
  3. Do unit tests.
  4. Push to GitHub.
  5. Create PR with reviewers.
  6. Do the edit/review/push cycle.
  7. Merge the changes.

The tech writer approach

It's much like the developer appoach.

Tech writers do the following:
  1. Author documentation.

  2. Push to GitHub.

  3. Create a PR with reviewers.

  4. Do the edit/revise/push cycle.

  5. Merge changes.

About

Docs like code demo

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published