Data

Tools

Indexes

Applications

Experiments

Open Source Science

diataxis-documentation-framework

A systematic approach to creating better documentation.

https://github.com/evildmp/diataxis-documentation-framework

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (2.1%) to scientific vocabulary

Keywords

documentation
Last synced: 6 months ago · JSON representation ·

Repository

A systematic approach to creating better documentation.

Basic Info
  • Host: GitHub
  • Owner: evildmp
  • License: other
  • Language: HTML
  • Default Branch: main
  • Homepage: https://diataxis.fr
  • Size: 9.16 MB
Statistics
  • Stars: 955
  • Watchers: 24
  • Forks: 174
  • Open Issues: 51
  • Releases: 0
Topics
documentation
Created almost 6 years ago · Last pushed 10 months ago
Metadata Files
Readme License Citation

README.rst 

The documentation system
========================

A comprehensive and practical system that can help maintainers of product documentation.

Published at https://diataxis.fr

Author: Daniele Procida

License: `CC-BY-SA 4.0 `_

Owner

  • Name: Daniele Procida
  • Login: evildmp
  • Kind: user
  • Location: Cardiff, Wales
  • Company: Canonical

Director of Engineering at Canonical. Creator of Diátaxis and BrachioGraph. Django core developer. Fellow of the Python Software Foundation.

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Diátaxis documentation framework
message: >-
  Please cite this software using the metadata from 'preferred-citation'
type: software
authors:
  - email: daniele@vurt.org
    orcid: 'https://orcid.org/0000-0001-5141-7509'
    given-names: Daniele
    family-names: Procida
preferred-citation:
  type: generic
  authors:
  - given-names: Daniele
    family-names: Procida
    orcid: 'https://orcid.org/0000-0001-5141-7509'
  title: Diátaxis documentation framework
  url: "https://diataxis.fr/"

GitHub Events

Total
  • Issues event: 7
  • Watch event: 120
  • Issue comment event: 25
  • Push event: 12
  • Pull request event: 9
  • Fork event: 17
Last Year
  • Issues event: 7
  • Watch event: 120
  • Issue comment event: 25
  • Push event: 12
  • Pull request event: 9
  • Fork event: 17

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 4
  • Total pull requests: 3
  • Average time to close issues: over 2 years
  • Average time to close pull requests: 5 months
  • Total issue authors: 4
  • Total pull request authors: 3
  • Average comments per issue: 0.75
  • Average comments per pull request: 1.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: about 2 months
  • Issue authors: 3
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.5
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • chendrix (1)
  • galenseilis (1)
  • dukenmarga (1)
  • rrg92 (1)
  • kannes (1)
  • hisamafahri (1)
  • sir-kokabi (1)
  • andre-c-andersen (1)
  • matevz (1)
  • pawamoy (1)
  • priyakumari02 (1)
  • rehevkor5 (1)
  • norman-abramovitz (1)
Pull Request Authors
  • DahanDv (4)
  • christianlaurent1992 (1)
  • cdemarco-drw (1)
  • dudo (1)
  • gregoryv (1)
  • corneliusroemer (1)
  • dependabot[bot] (1)
  • nimonian (1)
  • Andrew15-5 (1)
  • HAYVENO (1)
  • daniel-prefect (1)
  • shamefulCake1 (1)
  • 0anas01 (1)
  • giacomd (1)
  • RobyCollibra (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (1)

Dependencies

requirements.txt pypi
  • Babel ==2.9.1
  • Jinja2 ==3.0.3
  • MarkupSafe ==2.0.1
  • Pygments ==2.11.2
  • Sphinx ==4.4.0
  • alabaster ==0.7.12
  • beautifulsoup4 ==4.10.0
  • certifi ==2021.10.8
  • charset-normalizer ==2.0.10
  • colorama ==0.4.4
  • docutils ==0.17.1
  • furo ==2022.1.2
  • idna ==3.3
  • imagesize ==1.3.0
  • importlib-metadata ==4.10.1
  • livereload ==2.6.3
  • packaging ==21.3
  • pyenchant ==3.2.2
  • pyparsing ==3.0.6
  • pytz ==2021.3
  • requests ==2.27.1
  • six ==1.16.0
  • snowballstemmer ==2.2.0
  • soupsieve ==2.3.1
  • sphinx-autobuild ==2021.3.14
  • sphinx-design ==0.0.13
  • sphinxcontrib-applehelp ==1.0.2
  • sphinxcontrib-devhelp ==1.0.2
  • sphinxcontrib-htmlhelp ==2.0.0
  • sphinxcontrib-jsmath ==1.0.1
  • sphinxcontrib-qthelp ==1.0.3
  • sphinxcontrib-serializinghtml ==1.1.5
  • sphinxcontrib-spelling ==7.3.2
  • tornado ==6.1
  • urllib3 ==1.26.8
  • zipp ==3.7.0