Live data from Hacker News

Docs like code in basic terms

deborahwrites.com

11–20 of 61 posts

Re: Docs like code in basic terms

#11

I think from reading that, docs like code is roughly something like using Github and CI to manage docs rather than say WordPress or Confluence?

Yeah, exactly. If you're a developer, it can take a little bit to figure out that "docs like code" is a really strange concept to lots of non-developers.

The idea of using the same tools to manage your docs as you manage your code only makes sense if you understand what tools you use to manage code! If you don't -- if your main experience with documentation tooling is Word, or maybe MadCap stuff -- that's a really huge leap to make.

Re: Docs like code in basic terms

#13
Often the key is setting up an "executable documentation" environment.

For example, "executable documentation" lets you run automated tests on your markdown files, keeping content fresh.

some links:

- https://github.com/MicrosoftDocs/executable-docs

- https://simonwillison.net/2018/Jul/28/documentation-unit-tes...

Re: Docs like code in basic terms

#16
post #3

I didn’t realize that “docs like code” was a noun phrase and was trying to figure out how docs can be liking code that is in basic terms.

docs is plural. You can't have a plural in a noun phrase, other than in he head position.

For instance

OK, no plurals: law school entrance test

OK, head plural: law school entrance tests

?? non-head plural: law school entrances test

Re: Docs like code in basic terms

#18
post #3

I didn’t realize that “docs like code” was a noun phrase and was trying to figure out how docs can be liking code that is in basic terms.

docs is plural. You can't have a plural in a noun phrase, other than in he head position. For instance OK, no plurals: law school entrance test OK, head plural: law school entrance tests ?? non-head plural: law school entrances test

Interesting. Can you provide some source(s) for this rule?
Post reply on HN