Ask HN: How do you keep your documentation, how-to, examples and blogs updated?

1 pointsmanojbajaj952y ago3 comments

Blog posts, how-to guides, etc get outdated very quickly specially when you are doing multiple product launches. How do you keep them updated? Also, as a user i face issue of outdated documentations, guides as well as copilot give outdated responses.

3 comments

sargstuff2y ago

Specifics depend on project(s)/work environment(s); but literate programming[0] and using/enforcing coding/git/versioning standards can help automate a lot of things[1][2][3].

aka re: outdated responses -- blog and/or email list for when 'new/updated version' pushed out with errata/change log location.

[0] : https://blog.bitsrc.io/literate-programming-a-radical-approa...

[1] : https://blog.codacy.com/coding-standards

[2] : https://github.com/git-lfs/git-lfs/blob/main/.github/workflo...

[3] : https://github.com/git-lfs/git-lfs/blob/main/.github/workflo...

sargstuff2y ago

customizing git hooks : https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks

enforcing repository management policies : https://docs.github.com/en/enterprise-cloud@latest/admin/pol...

automating code formatting : https://medium.com/@sixpeteunder/automating-code-formatting-...

using git hooks to remind via email about other things on the check list that need to be updated/done per local policy (aka notice to user manual group about changes)

things to 'git' : https://www.redhat.com/sysadmin/git-hooks

managing organizational publications with git : https://docs.github.com/en/enterprise-server@3.11/organizati...

git for writers : https://www.gitkraken.com/gitkon/git-for-writers

git for blog posts : https://opensource.com/article/19/4/manage-multimedia-files-...

git for devops : https://www.atlassian.com/git/tutorials/comparing-workflows

retrocryptid2y ago

It's all in version control. Get is our house favorite. Documentation for the product is in the product's repo.

j / k navigate · click thread line to collapse

3 comments

sargstuff2y ago

Specifics depend on project(s)/work environment(s); but literate programming[0] and using/enforcing coding/git/versioning standards can help automate a lot of things[1][2][3].

aka re: outdated responses -- blog and/or email list for when 'new/updated version' pushed out with errata/change log location.

[0] : https://blog.bitsrc.io/literate-programming-a-radical-approa...

[1] : https://blog.codacy.com/coding-standards

[2] : https://github.com/git-lfs/git-lfs/blob/main/.github/workflo...

[3] : https://github.com/git-lfs/git-lfs/blob/main/.github/workflo...

sargstuff2y ago

customizing git hooks : https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks

enforcing repository management policies : https://docs.github.com/en/enterprise-cloud@latest/admin/pol...

automating code formatting : https://medium.com/@sixpeteunder/automating-code-formatting-...

using git hooks to remind via email about other things on the check list that need to be updated/done per local policy (aka notice to user manual group about changes)

things to 'git' : https://www.redhat.com/sysadmin/git-hooks

managing organizational publications with git : https://docs.github.com/en/enterprise-server@3.11/organizati...

git for writers : https://www.gitkraken.com/gitkon/git-for-writers

git for blog posts : https://opensource.com/article/19/4/manage-multimedia-files-...

git for devops : https://www.atlassian.com/git/tutorials/comparing-workflows

retrocryptid2y ago

It's all in version control. Get is our house favorite. Documentation for the product is in the product's repo.

j / k navigate · click thread line to collapse