From 98f7baac1745a49f3dd379f84eb7b63322442dd9 Mon Sep 17 00:00:00 2001
From: Dario Piotrowicz <dario.piotrowicz@gmail.com>
Date: Sun, 16 Mar 2025 16:42:48 +0000
Subject: [PATCH] doc: add new writing-docs contributing md

---
 doc/contributing/writing-docs.md | 38 ++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 doc/contributing/writing-docs.md

diff --git a/doc/contributing/writing-docs.md b/doc/contributing/writing-docs.md
new file mode 100644
index 00000000000000..219bb2ae5f8ad1
--- /dev/null
+++ b/doc/contributing/writing-docs.md
@@ -0,0 +1,38 @@
+# How to write documentation for the Node.js project
+
+This document refers to the Node.js API documentation that gets deployed to [nodejs.org/en/doc][]
+and consists in a general reference on how to write and update such documentation.
+
+## Style Guide
+
+For a style guide on how to write or update the Node.js documentation refer to the [doc/README][] document.
+
+## Building
+
+There are a few different commands that you can use to build and view the documentation locally,
+the simplest one being:
+
+```bash
+make docserve
+```
+
+This command builds the documentation, spins up a local server and provides you with a URL to
+it that you can navigate to in order to view the built documentation.
+
+For more build options refer to the [documentation building][building-the-documentation] documentation.
+
+And for more details about the tooling used to build the documentation refer to
+the [API Documentation Tooling][] document.
+
+## Linting and Formatting
+
+To make sure that your changes pass linting run the following command:
+
+```bash
+make lint-md
+```
+
+[API Documentation Tooling]: ./api-documentation.md
+[building-the-documentation]: ../../BUILDING.md#building-the-documentation
+[doc/README]: ../../doc/README.md
+[nodejs.org/en/doc]: https://nodejs.org/en/docs/