Comments (1)
I wish your comment had some hyperlinks to the concept you have mentioned, like, for example, to a Diátaxis, a pragmatic system for technical documentation writing Reddit thread.
I think Diátaxis favours being easy to the user over efficiency of documentation maintenance - being easy to the writer. In the tutorial section, for example, it promises nothing but blood, sweat and tears. I do not see much about re-use and modularity. This means, that if needed, the same information needs to be repeated in a slightly different way over and over. The core tenant of DITA seems to be trying manage this repetition.
I think nothing prevents someone to demonstrate how the toolkit provided by DITA is able to provide the documentation that is built according to the Diátaxis principles. if so desired. Personally I do not see any need to change this very repository with respect to that, though.
from diataxis-documentation-framework.
Related Issues (20)
- Use the diataxis framework for the diataxis framework website?
- INQUIRY : POSSIBLE LANGUAGE TRANSLATIONS HOT 1
- Q: Why adoption page's removed?
- In tutorial section know is written twice HOT 1
- Provide diataxis framework as an ebook
- Theme Template License
- Choose a programming language from the navbar once, rather than for each code box.
- Possible plagiarism? EDIT: nope, all good HOT 2
- anti-pedagogical temptations invisible on dark mode
- Translation HOT 2
- Duplicate words HOT 1
- What is the actual name? HOT 4
- Humans should not be referred to as "it"
- broken link to Gitlab HOT 1
- How-to guides "task-" vs "goal-oriented" inconsistency
- Dark logo and dark-mode-ready content
- Update year in footer
- Transifex status and join request approval HOT 2
- Use sphinx opengraph HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from diataxis-documentation-framework.