TE
科技回声
首页24小时热榜最新最佳问答展示工作
GitHubTwitter
首页

科技回声

基于 Next.js 构建的科技新闻平台,提供全球科技新闻和讨论内容。

GitHubTwitter

首页

首页最新最佳问答展示工作

资源链接

HackerNews API原版 HackerNewsNext.js

© 2025 科技回声. 版权所有。

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

1 点作者 manojbajaj95超过 1 年前
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 条评论

sargstuff超过 1 年前
Specifics depend on project(s)&#x2F;work environment(s); but literate programming[0] and using&#x2F;enforcing coding&#x2F;git&#x2F;versioning standards can help automate a lot of things[1][2][3].<p>aka re: outdated responses -- blog and&#x2F;or email list for when &#x27;new&#x2F;updated version&#x27; pushed out with errata&#x2F;change log location.<p>[0] : <a href="https:&#x2F;&#x2F;blog.bitsrc.io&#x2F;literate-programming-a-radical-approach-to-writing-code-with-documentation-ebb5dc892cd7" rel="nofollow noreferrer">https:&#x2F;&#x2F;blog.bitsrc.io&#x2F;literate-programming-a-radical-approa...</a><p>[1] : <a href="https:&#x2F;&#x2F;blog.codacy.com&#x2F;coding-standards" rel="nofollow noreferrer">https:&#x2F;&#x2F;blog.codacy.com&#x2F;coding-standards</a><p>[2] : <a href="https:&#x2F;&#x2F;github.com&#x2F;git-lfs&#x2F;git-lfs&#x2F;blob&#x2F;main&#x2F;.github&#x2F;workflows&#x2F;ci.yml#L15">https:&#x2F;&#x2F;github.com&#x2F;git-lfs&#x2F;git-lfs&#x2F;blob&#x2F;main&#x2F;.github&#x2F;workflo...</a><p>[3] : <a href="https:&#x2F;&#x2F;github.com&#x2F;git-lfs&#x2F;git-lfs&#x2F;blob&#x2F;main&#x2F;.github&#x2F;workflows&#x2F;ci.yml#L15">https:&#x2F;&#x2F;github.com&#x2F;git-lfs&#x2F;git-lfs&#x2F;blob&#x2F;main&#x2F;.github&#x2F;workflo...</a>
sargstuff超过 1 年前
customizing git hooks : <a href="https:&#x2F;&#x2F;git-scm.com&#x2F;book&#x2F;en&#x2F;v2&#x2F;Customizing-Git-Git-Hooks" rel="nofollow noreferrer">https:&#x2F;&#x2F;git-scm.com&#x2F;book&#x2F;en&#x2F;v2&#x2F;Customizing-Git-Git-Hooks</a><p>enforcing repository management policies : <a href="https:&#x2F;&#x2F;docs.github.com&#x2F;en&#x2F;enterprise-cloud@latest&#x2F;admin&#x2F;policies&#x2F;enforcing-policies-for-your-enterprise&#x2F;enforcing-repository-management-policies-in-your-enterprise" rel="nofollow noreferrer">https:&#x2F;&#x2F;docs.github.com&#x2F;en&#x2F;enterprise-cloud@latest&#x2F;admin&#x2F;pol...</a><p>automating code formatting : <a href="https:&#x2F;&#x2F;medium.com&#x2F;@sixpeteunder&#x2F;automating-code-formatting-with-git-hooks-7ef2af1202d8" rel="nofollow noreferrer">https:&#x2F;&#x2F;medium.com&#x2F;@sixpeteunder&#x2F;automating-code-formatting-...</a><p>using git hooks to remind via email about other things on the check list that need to be updated&#x2F;done per local policy (aka notice to user manual group about changes)<p>things to &#x27;git&#x27; : <a href="https:&#x2F;&#x2F;www.redhat.com&#x2F;sysadmin&#x2F;git-hooks" rel="nofollow noreferrer">https:&#x2F;&#x2F;www.redhat.com&#x2F;sysadmin&#x2F;git-hooks</a><p>managing organizational publications with git : <a href="https:&#x2F;&#x2F;docs.github.com&#x2F;en&#x2F;enterprise-server@3.11&#x2F;organizations&#x2F;managing-organization-settings&#x2F;managing-the-publication-of-github-pages-sites-for-your-organization" rel="nofollow noreferrer">https:&#x2F;&#x2F;docs.github.com&#x2F;en&#x2F;enterprise-server@3.11&#x2F;organizati...</a><p>git for writers : <a href="https:&#x2F;&#x2F;www.gitkraken.com&#x2F;gitkon&#x2F;git-for-writers" rel="nofollow noreferrer">https:&#x2F;&#x2F;www.gitkraken.com&#x2F;gitkon&#x2F;git-for-writers</a><p>git for blog posts : <a href="https:&#x2F;&#x2F;opensource.com&#x2F;article&#x2F;19&#x2F;4&#x2F;manage-multimedia-files-git" rel="nofollow noreferrer">https:&#x2F;&#x2F;opensource.com&#x2F;article&#x2F;19&#x2F;4&#x2F;manage-multimedia-files-...</a><p>git for devops : <a href="https:&#x2F;&#x2F;www.atlassian.com&#x2F;git&#x2F;tutorials&#x2F;comparing-workflows" rel="nofollow noreferrer">https:&#x2F;&#x2F;www.atlassian.com&#x2F;git&#x2F;tutorials&#x2F;comparing-workflows</a>
retrocryptid超过 1 年前
It&#x27;s all in version control. Get is our house favorite. Documentation for the product is in the product&#x27;s repo.