Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ If you have a monolithic, feature-based manual, you can convert it to a set of m

The result is documentation that is more relevant for your readers, because it is based on real-world user stories (it tells them how to accomplish their goals), and modular (it can be assembled into whatever sets and formats they might need).


.Prerequisites

* You should understand what modular documentation is:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[id="what-modular-documentation-is"]
= What Modular Documentation Is

Modular documentation is documentation based on _modules_, which the writer combines into _assemblies_. An assembly can also include other assemblies.
Modular documentation is documentation based on _modules_, which the writer combines into _assemblies_. An assembly can also include other assemblies. A module should not contain another module.

[IMPORTANT]
====
Expand Down
21 changes: 21 additions & 0 deletions modular-docs-manual/content/topics/using-text-snippets.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[id="using-text-snippets"]

= Text Snippets

A text snippet is a small section of text that is stored in an AsciiDoc file. Text snippets contain content that is resused in multiple modules or assemblies, for example:

* A step or series of steps in a procedure
* A disclaimer, for example, for technology preview or beta releases

NOTE: A text snippet is not a module.

.Procedure
. Create the text snippet AsciiDoc file.
+
NOTE: Consider storing snippet files in a separate snippets folder.
. Add an `include::` statement to the file that you want to add the snippet to, for example:
+
[source]
----
include::snippets/beta-note.adoc
----

This file was deleted.

4 changes: 3 additions & 1 deletion modular-docs-manual/content/topics/writing-mod-docs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Follow these guidelines to create different types of modules:
* xref:creating-procedure-modules[Procedure Module]
* xref:reference-module-guidelines[Reference Module]

A module should not contain another module. However a module can contain a text snippet. For information about text snippets, see xref:using-text-snippets[Using Text Snippets].
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sterobin can you see why this xref isn't working?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. Thanks Stetson.


See <<appendix-examples>> for real-world examples of assemblies, modules, and their individual parts.

include::creating_concept_modules.adoc[leveloffset=+2]
Expand All @@ -21,7 +23,7 @@ include::creating_procedure_modules.adoc[leveloffset=+2]

include::creating_reference_modules.adoc[leveloffset=+2]

include::using_text_snippets_or_text_fragments.adoc[leveloffset=+2]
include::using-text-snippets.adoc[leveloffset=+2]

include::module_anchor-and-file-names-concept.adoc[leveloffset=+2]

Expand Down