Michael KempeJul 27, 2023
sudo rm -rf fascism

When writing documentation, people often do not know where to start. Also creating a structure is hard.

I like make things simple.

We created the DEVEN documentation skeleton, a boiler to create solid docs.

It's open source now.

Enjoy ❤️

https://www.npmjs.com/package/deven-documentation-skeleton

https://github.com/deven-org/documentation-skeleton/tree/main/src/doc

deven-documentation-skeleton

Documentation Skeleton to standardise project documentation.. Latest version: 2.0.0, last published: 6 months ago. Start using deven-documentation-skeleton in your project by running `npm i deven-documentation-skeleton`. There are no other projects in the npm registry using deven-documentation-skeleton.

npm
Jul 25, 2023 at 7:21pmWeb
Show threadLarge Heydon ColliderJul 25, 2023
@misprintedtype nice, we need more stuff like this!!
Show threadsudo rm -rf fascismJul 25, 2023
@heydon actually, on it. 😅
Show threadsudo rm -rf fascismJul 25, 2023
@heydon anything specific you'd like to see or are missing?
Show threadLarge Heydon ColliderJul 26, 2023
@misprintedtype Hmm. Some examples on what to write for each section of the docs? That may be in the project README already but honestly I was having trouble demarcating the project docs and the docs you might write via the project?
Show threadsudo rm -rf fascismJul 26, 2023
@heydon did you check the skeleton yet? :)
Show threadLarge Heydon ColliderJul 26, 2023

@misprintedtype Oh! All I could see was this file tree.

.
└── src/doc
└── README.md
└── ARCHITECTURE.md
└── CODEOFCONDUCT.md
└── CONTRIBUTE.md
└── DEPLOYMENT.md
└── GETSTARTED.md
└── GLOSSARY.md
└── PROJECTBACKGROUND.md
└── TESTING.md

Do I have to install the package to see a skeleton for each part?

Show threadsudo rm -rf fascismJul 26, 2023

@heydon you can take a look inside the repo.

https://github.com/deven-https://github.com/deven-org/documentation-skeleton/tree/main/src/doc

Show threadLarge Heydon ColliderJul 26, 2023
@misprintedtype Ahhh. I found some now (https://github.com/deven-org/documentation-skeleton/blob/main/src/doc/ARCHITECTURE.md). I think it might help if the nodes in the file tree diagram were linked to these files in the src?
documentation-skeleton/src/doc/ARCHITECTURE.md at main · deven-org/documentation-skeleton

Documentation Skeleton. Contribute to deven-org/documentation-skeleton development by creating an account on GitHub.

GitHub
Show threadsudo rm -rf fascismJul 26, 2023
@heydon feel free to send a PR if you like :)
Show threadLarge Heydon ColliderJul 26, 2023
@misprintedtype I tried :( Having some git problems. Basically, I was trying this:
.
└── src/doc
└── README.md
└── [ARCHITECTURE.md](https://github.com/deven-org/documentation-skeleton/blob/main/src/doc/ARCHITECTURE.md)
└── [CODEOFCONDUCT.md](https://github.com/deven-org/documentation-skeleton/blob/main/src/doc/CODEOFCONDUCT.md)
└── [CONTRIBUTE.md](https://github.com/deven-org/documentation-skeleton/blob/main/src/doc/CONTRIBUTE.md)
└── [DEPLOYMENT.md](https://github.com/deven-org/documentation-skeleton/blob/main/src/doc/DEPLOYMENT.md)
└── [GETSTARTED.md](https://github.com/deven-org/documentation-skeleton/blob/main/src/doc/GETSTARTED.md)
documentation-skeleton/src/doc/ARCHITECTURE.md at main · deven-org/documentation-skeleton

Documentation Skeleton. Contribute to deven-org/documentation-skeleton development by creating an account on GitHub.

GitHub
Show threadLarge Heydon ColliderJul 26, 2023

@misprintedtype

└── [GLOSSARY.md](https://github.com/deven-org/documentation-skeleton/blob/main/src/doc/GLOSSARY.md)
└── [PROJECTBACKGROUND.md](https://github.com/deven-org/documentation-skeleton/blob/main/src/doc/PROJECTBACKGROUND.md)
└── [TESTING.md](https://github.com/deven-org/documentation-skeleton/blob/main/src/doc/TESTING.md)

documentation-skeleton/src/doc/GLOSSARY.md at main · deven-org/documentation-skeleton

Documentation Skeleton. Contribute to deven-org/documentation-skeleton development by creating an account on GitHub.

GitHub